![]() When working with VS.NET I noticed that the Tools/Build comment web pages is a great motivaiton for me to add useful function and class comments to my sources. Undocumented classes are excluded, This will very much reduce the clutter in the detailed documentaiton section. ![]() Note: as soon as you have added a basic doxy-comment to the important classes, you should turn off the EXTRACT_ALL option (as done in default2.doxygen). original code ġ4 additional lines (with ehavy copy&paste) I prepared an example for a small class of another article, which had virtually no documentable comments. Void Init(RECT const & oldRect, RECT const & newRect, DWORD snapwidth) / use this method if the window is about to be moved or resized (e.g. / Initializes the structure with an old an a new rectangle. Add a comment block before classes and structures, using /// Unless you already use some comment style that doxygen understands, the documentation is pretty much meaningless. Click on "Data Structures" in the top line to browse your classes etc. The "Main Page" is probably rather boring. If you use VSS, I'd also add it to SourceSafeĬhoose Tools/doxygen from the menu, and watch the magic happen (doxygen will log it's progress and complaints to the output window).Ĭhoose Tools/View results to explore the documentation. right click the file, and choose "Insert File into Project / ".change the ***PROJECT NAME*** to the name of your project.copy the default.doxygen file into your project folder (this file contains doxygen configuration options).open the project you want to add the file to.Arguments: "$(WkspDir)\doxydoc\index.html". ![]() c:\program files\internet explorer\iexplore.exe
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |