Doxygen-announce — Be notified of new releases and important events (low traffic).
Contributors
Introduction
As described by Matthias Mueller-Prove from Sun OpenOffice.org team, different mediums have different purposes and advantages (first and second blog entry).
After effect element 3d plugin free download mac. OpenOffice.org Wiki is good for Work-in-Progress documentation and when trying to capture high-level descriptions for the OpenOffice.org architecture and functionality. Easy and quick collaboration by editing wiki is much better way than editing static webpages, which can be accessed by much fewer people (and require the knowledge to code HTML and use CVS).
However, when documenting the code at function level (i.e. describing each function), it is VERY important that the documentation is intimately tied to the code, not elsewhere in some hard-to-guess url. When documentation is in the code, it also has the best chances to stay up-to-date with the changes in the code. Function documentation MUST stay up-to-date or it is hindering coding, not helping.
Any diagrams of code structure must also be generated dynamically, to ensure that the diagrams are always up-to-date.
Doxygen and Javadoc -style commentsDoxygen Windows Download
So how can the above requirements be fulfilled? Well, there is the widely used and standard tool for this: Doxygen. It allows us to do even very complex documentation if needed.
While Doxygen has it's (default) own format for creating function documentation, it also supports JavaDoc -style of documentation. The JavaDoc -style is the preferred one for OpenOffice.org, because it allows us to have consistent documentation style for both Java and C/C++ code. Note that JavaDoc -program (itself) can only be used for .java source files, this is the reason to use Doxygen instead. Adobe pdf mac download free.
Using Doxygen
Painkiller gold edition cd key generator. For Mac OS X, you can download Doxygen from [1]. It includes also a GUI with which you can relatively easily create documentation yourself.
When using the Wizard:
Skype version 7 download mac.
Documentation for the use of Doxygen is available on the Doxygen webpage
For an example of OpenOffice.org documentation with Doxygen, see the Canvas -module (milestone 202 with cws cairoquartz01) and especially the cairo canvas, Surface class -documentation
The vcl -module can be read too. It has the Diagrams enabled.
Code documentation style
To provide consistent style, please put the function documentation to the SOURCE file (e.g. salfoo.cxx or salfoo.c), NOT in the header file (e.g. salfoo.h)
Doxygen Download Mac Os X 10.11
While more details can be seen in the documentation, the following example should show you all the important things you need. Look at the stuff between /** and */.
While the code below shows how you write documentation, you should look e.g. at cairo_cairo.cxx about what should be written in the documentation.
Current and Future work
Physique des solides ashcroft mermin pdf to jpg. The javadoc-style documentation has been started, but more focused effort is needed. The examples in actual code can be seen in at least:
Future goal is to have dynamically created documentation of the core OpenOffice.org modules in the web, with updates in every milestone, or even daily. While very small part of the code has javadoc-style comments, doxygen still creates the code structure documentation automatically :)
Download Doxygen
Retrieved from 'https://wiki.openoffice.org/w/index.php?title=Mac_OS_X_Porting_-_Code_Documentation&oldid=25841'
Comments are closed.
|
AuthorWrite something about yourself. No need to be fancy, just an overview. Archives
December 2020
Categories |