Editing Doxygen

Warning: You are not logged in.

Your IP address will be recorded in this page's edit history.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 6: Line 6:
  
 
make dox - this is the toplevel Doxygen target, and the preferred way to generate the documentation.  It works on all the libraries simultaneously, which makes for the best quality documentation but may also take longer to generate output.
 
make dox - this is the toplevel Doxygen target, and the preferred way to generate the documentation.  It works on all the libraries simultaneously, which makes for the best quality documentation but may also take longer to generate output.
 
To view the output generated from this command, open it in firefox or some other web browser:
 
 
firefox doc/doxygen_output/html/index.html
 
  
 
make dox-<lib**> - per library doxygen targets that build documentation only for a single library (libbu, librt, etc.)
 
make dox-<lib**> - per library doxygen targets that build documentation only for a single library (libbu, librt, etc.)
 
The per-library outputs will be in their own directories:
 
 
firefox doc/doxygen_libbu/html/index.html
 
  
 
== Editing Doxygen ==
 
== Editing Doxygen ==

Please note that all contributions to BRL-CAD may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BRL-CAD:Copyrights for details). Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)