I was just thinking about this as I probably wouldn't use the standard
doxygen output much, but can definitely see the usefulness when integrated
into our code indexers which I use quite often. Most useful to me would be:
- @param doc when hovering over a param (in function, or when calling a
function)
- bonus points for annotating the type
- @class doc when hovering over a class (fallback to base class would
be nice)
- @method doc when hovering over a function definition or call
Integrating IDL docs would be nice as well.
-e
On Tue, Feb 21, 2017 at 12:13 PM, Bill McCloskey <wmcclos...@mozilla.com>
wrote:
> I've been thinking about how to integrate documentation into Searchfox. One
> obvious thing is to allow it to display Markdown files and
> reStructuredText. I wonder if it could do something useful with Doxygen
> comments though? Is this something people would be interested in?
>
> On Tue, Feb 21, 2017 at 11:53 AM, Ted Mielczarek <t...@mielczarek.org>
> wrote:
>
> > We have auto-generated docs using Sphinx on ReadTheDocs[1]. If someone
> > was motivated, it looks like there does exist code[2] to bridge doxygen
> > docs into Sphinx, so it should be possible to get those docs into the
> > existing RTD setup. There are even docs on RTD[3] for how to add new
> > docs!
> >
> > -Ted
> >
> > 1. http://gecko.readthedocs.io/en/latest/
> > 2. https://breathe.readthedocs.io/en/latest/
> > 3. http://gecko.readthedocs.io/en/latest/#adding-documentation
> >
> >
> > On Mon, Feb 20, 2017, at 11:38 AM, Milan Sreckovic wrote:
> > > Not being kept up to date as far as I know. My extraction is four
> years
> > > out of date (e.g.,
> > > https://people-mozilla.org/~msreckovic/Extracted/
> > MozillaCentral/html/annotated.html)
> > > and as you noted, Benoit's page is no longer.
> > >
> > > The code used to create it is here:
> > > https://github.com/bgirard/doxygen-mozilla
> > >
> > >
> > > On 20-Feb-17 2:05, Henri Sivonen wrote:
> > > > Our comments mostly try to follow the Doxygen format, and MDN says
> > > > that the documentation team has a tool for importing
> Doxygen-formatted
> > > > IDL comments into MDN articles.
> > > >
> > > > Other than that, is Doxygen output from m-c input being published
> > anywhere?
> > > >
> > > > https://people-mozilla.org/~bgirard/doxygen/gfx/ is 404 these days.
> > > >
> > >
> > > --
> > > - Milan (mi...@mozilla.com)
> > >
> > > _______________________________________________
> > > dev-platform mailing list
> > > dev-platform@lists.mozilla.org
> > > https://lists.mozilla.org/listinfo/dev-platform
> > _______________________________________________
> > dev-platform mailing list
> > dev-platform@lists.mozilla.org
> > https://lists.mozilla.org/listinfo/dev-platform
> >
> _______________________________________________
> dev-platform mailing list
> dev-platform@lists.mozilla.org
> https://lists.mozilla.org/listinfo/dev-platform
>
_______________________________________________
dev-platform mailing list
dev-platform@lists.mozilla.org
https://lists.mozilla.org/listinfo/dev-platform
