On 08/01/2012 07:48 AM, an...@khirnov.net wrote: > > Hi, > I have a disagreement with Diego about generating doxygen docs. > > Currently we generate doxygen for all files in Libav, which IMO leads to > horribly cluttered output. > See e.g. > https://libav.org/doxygen/master/files.html > https://libav.org/doxygen/master/annotated.html > https://libav.org/doxygen/master/classes.html > https://libav.org/doxygen/master/globals_func.html > A mountain of stuff that's absolutely useless to people who want public > API documentation. It just makes searching for what they need much > harder. > > For this reason I think we should only generate doxy for installed > headers, so the output contains only public API documentation. > At least that should be the default, we can have a second alternative > doxy config file that would generate docs for everything. > > OTOH Diego claims we should keep generating doxy for all files. I'm sure > he'll present his reasons and arguments himself. > > If there indeed are people who read generated doxy for non-public API, > I'd like them to speak up and prove their existence. > Everyone else with an opinion is of course welcome to comment as well.
+1 on public API doxy by default, internal doxy with option. -Justin _______________________________________________ libav-devel mailing list libav-devel@libav.org https://lists.libav.org/mailman/listinfo/libav-devel
