On Tue, Feb 21, 2017 at 12:42 AM, <gsquel...@mozilla.com> wrote:
> My short (<2yr) experience of the code gave me the impression that only a
> small amount of it has proper doxygen comments.
> We must be frequenting different circles; or I'm somehow blind to them. :-)
I get to look at stuff like:
/**
* Cause parser to parse input from given URL
* @update gess5/11/98
* @param aURL is a descriptor for source document
* @param aListener is a listener to forward notifications to
* @return TRUE if all went well -- FALSE otherwise
*/
> Anyway, they're mainly useful when generated websites/documents are readily
> available, which it seems isn't the case (anymore).
Right. I'm trying to assess how much effort I should put into writing
Doxygen-formatted docs, and if we aren't really publishing Doxygen
output, I feel like it's probably good to write /** ... */ in case we
start using Doxygen again but probably not worthwhile to use the @
tags.
On Tue, Feb 21, 2017 at 10: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?
I think integrating docs with Searchfox would be more useful than
having unintegrated Doxygen output somewhere. Compared to just reading
a .h with comments, I think a documentation view would be particularly
useful for templates and headers with a lot of inline definitions as a
means to let the reader focus on the interface and hide the
implementation (including hiding whatever is in a namespace with the
substring "detail" in the name of the namespace for templates).
_______________________________________________
dev-platform mailing list
dev-platform@lists.mozilla.org
https://lists.mozilla.org/listinfo/dev-platform
