11/13/2023 0 Comments Doxygen example headerDoxygen has settings for hiding private API.This won't work if you want to hide things intentionally as well, ie private functions and classes for internal use.Undocumented functions would show up in the docs, making clear that it exists and is part of the official API. No more unintentionally undocumented functions.One of the strengths of doxygen is that method docs can immediately precede the implementation, making them right in the developer face and hence more likely to be updated -AndyDent Only if the comments are stored separately.Not really, you still have to switch to whatever file the doxygen comments are in to update them, which is only slightly more convenient than switching to a tex file.When the code changes, docs are more likely to be updated with it.I think now most of them don't bother to learn some strange tex-based system specific to wxWidgets. They could easily 'doxygenify' the comments they *should* be writing anyway, just by looking at some examples. Most developers already know Doxygen or wouldn't mind learning it (since it'd be useful for other projects, too).It isn't production quality but it beats grepping. Hint: If you just want to use Doxygen to help you find your way around wxWidget sources while this documentation issue is resolved, you can get half-decent quick and dirty source-level documentation by tossing the wxWidgets source code for a given platform (exclude all others) at Doxygen and setting ENABLE_PREPROCESSING = NO. The doxygen config file used for the gen.Proof that wxControl has been made a parent of wxObject and wxWindow, and proof that documentation need not be in the source or header files, can be found here:
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |