Doxygen - Revision history

Flixr: /* Doxygen Style */

2013-11-22T16:52:56Z

Doxygen Style

← Older revision		Revision as of 10:52, 22 November 2013
Line 31:		Line 31:
	== Doxygen Style ==		== Doxygen Style ==

	The [http://~~paparazzi~~.~~github~~.~~com/docs~~/latest/styledoxygen.html Paparazzi Doxygen style guide] is of course written in doxygen as well ;-)		The [http://docs.paparazziuav.org/latest/styledoxygen.html Paparazzi Doxygen style guide] is of course written in doxygen as well ;-)

	Please [http://www.stack.nl/~dimitri/doxygen/docblocks.html document the code using doxygen comments] instead of normal comments where appropriate.		Please [http://www.stack.nl/~dimitri/doxygen/docblocks.html document the code using doxygen comments] instead of normal comments where appropriate.

Flixr: update docs url

2013-11-22T16:52:26Z

update docs url

← Older revision		Revision as of 10:52, 22 November 2013
Line 1:		Line 1:
	[http://www.doxygen.org Doxygen] is a documentation system that also extracts information from the source files directly.		[http://www.doxygen.org Doxygen] is a documentation system that also extracts information from the source files directly.

	'''Daily generated docs for the development and stable branches can be found on [http://~~paparazzi~~.~~github~~.~~io/~~docs ~~paparazzi~~.~~github~~.~~io/docs~~].'''		'''Daily generated docs for the development and stable branches can be found on [http://docs.paparazziuav.org docs.paparazziuav.org].'''

	== Generating Doxygen Code Documentation yourself ==		== Generating Doxygen Code Documentation yourself ==

Flixr: add info on doxygen backport for precise and make dox

2013-08-30T14:40:06Z

add info on doxygen backport for precise and make dox

← Older revision		Revision as of 08:40, 30 August 2013
Line 1:		Line 1:
	[http://www.doxygen.org Doxygen] is a documentation system that also extracts information from the source files directly.		[http://www.doxygen.org Doxygen] is a documentation system that also extracts information from the source files directly.

	Daily generated docs for the development and stable branches can be found on [http://paparazzi.github.io/docs paparazzi.github.io/docs].		'''Daily generated docs for the development and stable branches can be found on [http://paparazzi.github.io/docs paparazzi.github.io/docs].'''

	== Generating Doxygen Code Documentation yourself ==		== Generating Doxygen Code Documentation yourself ==

	A way to look at the includes and dependencies is to use the graphs generated with doxygen. After installing Paparazzi, install Doxygen:		A way to look at the includes and dependencies is to use the graphs generated with doxygen. After installing Paparazzi, install Doxygen:

			For Ubuntu precise a backport of doxygen_1.8.4 is available in the ppa:flixr/backports:

			sudo add-apt-repository ppa:flixr/backports
			sudo apt-get update

	sudo apt-get install doxygen graphviz		sudo apt-get install doxygen graphviz

	run the generation ~~tool~~ from the paparazzi/ directory:		run the documentation generation from the paparazzi/ directory (will generate module descriptions and run doxygen):

			make dox

			Prior to paparazzi_version v5.1_devel-234-gb1eb25e run doxygen manually from the paparazzi/ directory:
	doxygen		doxygen

	Now Doxygen will have generated html documentation(open this with any web browser) in your paparazzi/html~~/docs~~ folder.		Now Doxygen will have generated html documentation (open this with any web browser) in your paparazzi/docs/generated/html folder.

	~~To look at a list of all of the files used by the airborne software~~:		The main documentation page is:
	paparazzi/doc/~~html/docs~~/~~files.~~html		paparazzi/doc/generated/html/index.html
	~~The main_ap.c will also interest you.~~
	~~paparazzi/doc/html/docs~~/~~main__ap_8c~~.html

	This is a sample of a Doxygen Graph:		This is a sample of a Doxygen Graph:

Flixr: new url for github pages is paparazzi.github.io

2013-04-14T12:02:53Z

new url for github pages is paparazzi.github.io

← Older revision		Revision as of 06:02, 14 April 2013
Line 1:		Line 1:
	[http://www.doxygen.org Doxygen] is a documentation system that also extracts information from the source files directly.		[http://www.doxygen.org Doxygen] is a documentation system that also extracts information from the source files directly.

	Daily generated docs for the development and stable branches can be found on [http://paparazzi.github.~~com~~/docs paparazzi.github.~~com~~/docs].		Daily generated docs for the development and stable branches can be found on [http://paparazzi.github.io/docs paparazzi.github.io/docs].

	== Generating Doxygen Code Documentation yourself ==		== Generating Doxygen Code Documentation yourself ==

Flixr at 09:08, 1 August 2012

2012-08-01T09:08:35Z

← Older revision		Revision as of 03:08, 1 August 2012
Line 1:		Line 1:
	[http://www.doxygen.org Doxygen] is a documentation system that also extracts information from the source files directly.		[http://www.doxygen.org Doxygen] is a documentation system that also extracts information from the source files directly.

	~~Current documentation~~ generated ~~from~~ the ~~master branch~~ can be found ~~under~~ [http://paparazzi.github.com/docs paparazzi.github.com/docs].		Daily generated docs for the development and stable branches can be found on [http://paparazzi.github.com/docs paparazzi.github.com/docs].

	== Generating Doxygen Code Documentation yourself ==		== Generating Doxygen Code Documentation yourself ==

Flixr: fix link to styleguide

2012-07-31T20:27:03Z

fix link to styleguide

← Older revision		Revision as of 14:27, 31 July 2012
Line 25:		Line 25:
	== Doxygen Style ==		== Doxygen Style ==

	The [http://paparazzi.github.com/docs/styledoxygen.html Paparazzi Doxygen style guide] is of course written in doxygen as well ;-)		The [http://paparazzi.github.com/docs/latest/styledoxygen.html Paparazzi Doxygen style guide] is of course written in doxygen as well ;-)

	Please [http://www.stack.nl/~dimitri/doxygen/docblocks.html document the code using doxygen comments] instead of normal comments where appropriate.		Please [http://www.stack.nl/~dimitri/doxygen/docblocks.html document the code using doxygen comments] instead of normal comments where appropriate.

Flixr at 14:26, 20 January 2012

2012-01-20T14:26:23Z

@@ Line 3: / Line 3: @@
 Current documentation generated from the master branch can be found under [http://paparazzi.github.com/docs paparazzi.github.com/docs].
-== Doxygen Comments ==
+== Generating Doxygen Code Documentation yourself ==
 Please [http://www.stack.nl/~dimitri/doxygen/docblocks.html document the code using doxygen comments] instead of normal comments where appropriate.
@@ Line 37: / Line 59: @@
+  }
 [[Category:Software]] [[Category:Developer_Documentation]]

Flixr at 18:04, 19 January 2012

2012-01-19T18:04:09Z

← Older revision		Revision as of 12:04, 19 January 2012
Line 11:		Line 11:
	=== File ===		=== File ===

	/** \file nav.h		/**
	* ~~\brief~~ Navigation library		* @file subsystems/nav.h
			* Navigation library.
	*		*
	* This collection of macros and functions is used by the C code generated		* This collection of macros and functions is used by the C code generated
	* from the XML flight plan		* from the XML flight plan.
	*/		*/

	=== Function ===		=== Function ===
	/**		/**
	* \brief ~~<A short~~ one line description>		* A brief one line description.
	*		*
	* ~~<Longer~~ description>		* Detailed description
	* <May span multiple lines or paragraphs as needed>		* May span multiple lines or paragraphs as needed
	*		*
	* \param Description of method's or function's input parameter		* @param Description of method's or function's input parameter
	* \param ...		* @param ...
	* \return Description of the return value		* @return Description of the return value
	*/		*/
	int function(int parameter)		int function(int parameter)
Line 50:		Line 51:

	To look at a list of all of the files used by the airborne software:		To look at a list of all of the files used by the airborne software:
	paparazzi/html/docs/files.html		paparazzi/doc/html/docs/files.html
	The main_ap.c will also interest you.		The main_ap.c will also interest you.
	paparazzi/html/docs/main__ap_8c.html		paparazzi/doc/html/docs/main__ap_8c.html

	This is a sample of a Doxygen Graph:		This is a sample of a Doxygen Graph:

Flixr at 15:51, 16 January 2012

2012-01-16T15:51:00Z

New page

[http://www.doxygen.org Doxygen] is a documentation system that also extracts information from the source files directly.

Current documentation generated from the master branch can be found under [http://paparazzi.github.com/docs paparazzi.github.com/docs].

== Doxygen Comments ==

Please [http://www.stack.nl/~dimitri/doxygen/docblocks.html document the code using doxygen comments] instead of normal comments where appropriate.

See the [http://www.stack.nl/~dimitri/doxygen/manual.html Doxygen Manual] for more details.

=== File ===

/** \file nav.h
* \brief Navigation library
*
* This collection of macros and functions is used by the C code generated
* from the XML flight plan
*/

=== Function ===
/**
* \brief <A short one line description>
*
* <Longer description>
* <May span multiple lines or paragraphs as needed>
*
* \param Description of method's or function's input parameter
* \param ...
* \return Description of the return value
*/
int function(int parameter)
{
printf("Parameter: %d", parameter);

return 0;
}

== Generating Doxygen Code Documentation yourself ==

A way to look at the includes and dependencies is to use the graphs generated with doxygen. After installing Paparazzi, install Doxygen:

sudo apt-get install doxygen graphviz

run the generation tool from the paparazzi/ directory:

doxygen

Now Doxygen will have generated html documentation(open this with any web browser) in your paparazzi/html/docs folder.

To look at a list of all of the files used by the airborne software:
paparazzi/html/docs/files.html
The main_ap.c will also interest you.
paparazzi/html/docs/main__ap_8c.html

This is a sample of a Doxygen Graph:
[[Image:Autopilot_8h_incl.png|Include dependency graph for autopilot.h]]

[[Category:Software]] [[Category:Developer_Documentation]]