Doxygen style comments - Revision history

Abma at 00:47, 11 October 2015

2015-10-11T00:47:18Z

← Older revision		Revision as of 01:47, 11 October 2015
Line 1:		Line 1:
	Spring gets automatically generated documentation for the source code which can be found [~~http~~://springrts.com/~~doxygen~~/ here]. The tool used for this is [http://www.doxygen.org doxygen]. Whilst doxygen does a good job of producing diagrams and extracting logical relationships from the code, the documentation can be somewhat hard to digest without any descriptive text to read!		Spring gets automatically generated documentation for the source code which can be found [https://springrts.com/dl/buildbot/doc/ here]. The tool used for this is [http://www.doxygen.org doxygen]. Whilst doxygen does a good job of producing diagrams and extracting logical relationships from the code, the documentation can be somewhat hard to digest without any descriptive text to read!

	The good news is that doxygen can automatically extract your header comments from the code and use them as a description for the class/method/field they're associated with... as long as you stick to the doxygen comment style. Therefore, please put doxygen style comments into the code.		The good news is that doxygen can automatically extract your header comments from the code and use them as a description for the class/method/field they're associated with... as long as you stick to the doxygen comment style. Therefore, please put doxygen style comments into the code.

Flozi: recat

2013-03-20T19:57:40Z

recat

← Older revision		Revision as of 20:57, 20 March 2013
Line 15:		Line 15:
	The current codebase (0.65b2) contains non doxygen comments as we've only just started using it. If you do see header/field comments which start with just /* or //, please do a search-and-replace on them so that we can have the benefit of them in the documentation. Thanks		The current codebase (0.65b2) contains non doxygen comments as we've only just started using it. If you do see header/field comments which start with just /* or //, please do a search-and-replace on them so that we can have the benefit of them in the documentation. Thanks

	[[Category:~~Source development~~]]		[[Category:Engine Dev]]

Danuker at 17:25, 24 May 2010

2010-05-24T17:25:50Z

← Older revision		Revision as of 18:25, 24 May 2010
Line 1:		Line 1:
	TA Spring ~~has~~ automatically generated documentation for the source code which can be found [http://springrts.com/doxygen/ here]. The tool used for this is [http://www.doxygen.org doxygen]. Whilst doxygen does a good job of producing diagrams and extracting logical relationships from the code, the documentation can be somewhat hard to digest without any descriptive text to read!		Spring gets automatically generated documentation for the source code which can be found [http://springrts.com/doxygen/ here]. The tool used for this is [http://www.doxygen.org doxygen]. Whilst doxygen does a good job of producing diagrams and extracting logical relationships from the code, the documentation can be somewhat hard to digest without any descriptive text to read!

	The good news is that doxygen can automatically extract your header comments from the code and use them as a description for the class/method/field they're associated with... as long as you stick to the doxygen comment style. Therefore, please put doxygen style comments into the code.		The good news is that doxygen can automatically extract your header comments from the code and use them as a description for the class/method/field they're associated with... as long as you stick to the doxygen comment style. Therefore, please put doxygen style comments into the code.

Tobi: update link

2009-06-21T11:07:11Z

update link

← Older revision		Revision as of 12:07, 21 June 2009
Line 1:		Line 1:
	TA Spring has automatically generated documentation for the source code which can be found [http://~~taspring.clan-sy~~.com/doxygen/ here]. The tool used for this is [http://www.doxygen.org doxygen]. Whilst doxygen does a good job of producing diagrams and extracting logical relationships from the code, the documentation can be somewhat hard to digest without any descriptive text to read!		TA Spring has automatically generated documentation for the source code which can be found [http://springrts.com/doxygen/ here]. The tool used for this is [http://www.doxygen.org doxygen]. Whilst doxygen does a good job of producing diagrams and extracting logical relationships from the code, the documentation can be somewhat hard to digest without any descriptive text to read!

	The good news is that doxygen can automatically extract your header comments from the code and use them as a description for the class/method/field they're associated with... as long as you stick to the doxygen comment style. Therefore, please put doxygen style comments into the code.		The good news is that doxygen can automatically extract your header comments from the code and use them as a description for the class/method/field they're associated with... as long as you stick to the doxygen comment style. Therefore, please put doxygen style comments into the code.

SeanHeron: ad

2006-03-15T12:47:16Z

← Older revision		Revision as of 13:47, 15 March 2006
Line 14:		Line 14:

	The current codebase (0.65b2) contains non doxygen comments as we've only just started using it. If you do see header/field comments which start with just /* or //, please do a search-and-replace on them so that we can have the benefit of them in the documentation. Thanks		The current codebase (0.65b2) contains non doxygen comments as we've only just started using it. If you do see header/field comments which start with just /* or //, please do a search-and-replace on them so that we can have the benefit of them in the documentation. Thanks

			[[Category:Source development]]

Munchgreeble: Added more links in

2005-10-18T22:52:47Z

Added more links in

← Older revision		Revision as of 23:52, 18 October 2005
Line 11:		Line 11:
	Within the comment blocks you can also use [http://www.stack.nl/~dimitri/doxygen/commands.html special commands] including the very useful @todo command. All @todo commands are noted by Doxygen and pulled out into a single "TODO" list page, which lists all the @todo items across the entire project in one place.		Within the comment blocks you can also use [http://www.stack.nl/~dimitri/doxygen/commands.html special commands] including the very useful @todo command. All @todo commands are noted by Doxygen and pulled out into a single "TODO" list page, which lists all the @todo items across the entire project in one place.

	The full [http://www.stack.nl/~dimitri/doxygen/manual.html doxygen manual] describes all the various commenting conventions you can use which doxygen will pick up. This includes nice things like being able to mark several items as having the same comment, producing lists, links into other classes/methods, how to use HTML within comments etc.		The full [http://www.stack.nl/~dimitri/doxygen/manual.html doxygen manual] describes all the various commenting conventions you can use which doxygen will pick up. This includes nice things like being able to mark several items as having the same comment (part of [http://www.stack.nl/~dimitri/doxygen/grouping.html grouping]), producing [http://www.stack.nl/~dimitri/doxygen/lists.html lists], [http://www.stack.nl/~dimitri/doxygen/autolink.html links] into other classes/methods etc., how to use [http://www.stack.nl/~dimitri/doxygen/htmlcmds.html HTML] within the comments etc.

	The current codebase (0.65b2) contains non doxygen comments as we've only just started using it. If you do see header/field comments which start with just /* or //, please do a search-and-replace on them so that we can have the benefit of them in the documentation. Thanks		The current codebase (0.65b2) contains non doxygen comments as we've only just started using it. If you do see header/field comments which start with just /* or //, please do a search-and-replace on them so that we can have the benefit of them in the documentation. Thanks

Munchgreeble at 22:46, 18 October 2005

2005-10-18T22:46:55Z

← Older revision		Revision as of 23:46, 18 October 2005
Line 1:		Line 1:
	TA Spring has automatically generated documentation for the source code which can be found [http://taspring.clan-sy.com/doxygen/ here]. The tool used for this is [http://www.doxygen.org doxygen]. Whilst doxygen does a good job of producing diagrams and extracting logical relationships from the code, the documentation can be somewhat hard to digest without any descriptive text to read!		TA Spring has automatically generated documentation for the source code which can be found [http://taspring.clan-sy.com/doxygen/ here]. The tool used for this is [http://www.doxygen.org doxygen]. Whilst doxygen does a good job of producing diagrams and extracting logical relationships from the code, the documentation can be somewhat hard to digest without any descriptive text to read!

	Therefore, please put doxygen style comments into the code~~, which makes it all the nicer both when reading the code and also when reading the documentation~~. ~~It's~~ the same syntax as Javadoc basically. If you're not familiar with ~~that~~, the main thing you need to know is to use:		The good news is that doxygen can automatically extract your header comments from the code and use them as a description for the class/method/field they're associated with... as long as you stick to the doxygen comment style. Therefore, please put doxygen style comments into the code.

			Doxygen comments have the same syntax as Javadoc basically - if you're familiar with Javadoc, go ahead and write header comments as you normally would in Java. If you're not familiar with Javadoc, the main thing you need to know is to use:

	/**		/**

	At the start of your comment blocks (it also works with /*!). Or on the otherhand if you prefer using // style comments, use /// (or //! ~~if you prefer)~~.		At the start of your comment blocks (doxygen also works with /*!). Or on the otherhand if you prefer using // style comments, use /// or //! as your comment marker.

	Within the comment blocks you can also use [http://www.stack.nl/~dimitri/doxygen/commands.html special commands] including the very useful @todo command. All @todo commands are noted by Doxygen and pulled out into a single "TODO" list page, which lists all the @todo items across the entire project in one place.		Within the comment blocks you can also use [http://www.stack.nl/~dimitri/doxygen/commands.html special commands] including the very useful @todo command. All @todo commands are noted by Doxygen and pulled out into a single "TODO" list page, which lists all the @todo items across the entire project in one place.
Line 11:		Line 13:
	The full [http://www.stack.nl/~dimitri/doxygen/manual.html doxygen manual] describes all the various commenting conventions you can use which doxygen will pick up. This includes nice things like being able to mark several items as having the same comment, producing lists, links into other classes/methods, how to use HTML within comments etc.		The full [http://www.stack.nl/~dimitri/doxygen/manual.html doxygen manual] describes all the various commenting conventions you can use which doxygen will pick up. This includes nice things like being able to mark several items as having the same comment, producing lists, links into other classes/methods, how to use HTML within comments etc.

	The current codebase (0.65b2) ~~does contain~~ non doxygen comments as we've only just started using it. If you do see header/field comments which start with just /* or //, please do a search-and-replace on them so that we can have the benefit of them in the documentation. Thanks		The current codebase (0.65b2) contains non doxygen comments as we've only just started using it. If you do see header/field comments which start with just /* or //, please do a search-and-replace on them so that we can have the benefit of them in the documentation. Thanks

Munchgreeble: Initial doxygen comments page

2005-10-18T22:36:07Z

Initial doxygen comments page

New page

TA Spring has automatically generated documentation for the source code which can be found [http://taspring.clan-sy.com/doxygen/ here]. The tool used for this is [http://www.doxygen.org doxygen]. Whilst doxygen does a good job of producing diagrams and extracting logical relationships from the code, the documentation can be somewhat hard to digest without any descriptive text to read!

Therefore, please put doxygen style comments into the code, which makes it all the nicer both when reading the code and also when reading the documentation. It's the same syntax as Javadoc basically. If you're not familiar with that, the main thing you need to know is to use:

/**

At the start of your comment blocks (it also works with /*!). Or on the otherhand if you prefer using // style comments, use /// (or //! if you prefer).

Within the comment blocks you can also use [http://www.stack.nl/~dimitri/doxygen/commands.html special commands] including the very useful @todo command. All @todo commands are noted by Doxygen and pulled out into a single "TODO" list page, which lists all the @todo items across the entire project in one place.

The full [http://www.stack.nl/~dimitri/doxygen/manual.html doxygen manual] describes all the various commenting conventions you can use which doxygen will pick up. This includes nice things like being able to mark several items as having the same comment, producing lists, links into other classes/methods, how to use HTML within comments etc.

The current codebase (0.65b2) does contain non doxygen comments as we've only just started using it. If you do see header/field comments which start with just /* or //, please do a search-and-replace on them so that we can have the benefit of them in the documentation. Thanks