id	summary	reporter	owner	description	type	status	priority	milestone	component	version	resolution	keywords	cc	i_links	o_links
8	doxygen tags in src/	bensch	nobody	"Everything needs to be documented. And writing a good documentation is not easy, and takes a lot of time, but helps everyone in understanding, what we are doing. Thats the reason, why we should comment our code in the following standardized manner:
 * '''general'''
   * '''todo's''': make tags with ''\todo'' when something is bad implemented, or something is missing
 * '''h-file'''
   * '''file itself''': make a comment about all the h-files (this has mainly been done)
   * '''classes''': write a short comment above the classes with ''//! comment''
   * '''structs''': same as classes
   * '''variables''': write a short comment about the variable (at the end of the line insert: ''//!< cool variable because...'')
 * '''cc-files'''
   * '''member-functions''': write as much information about what the Function does and if possible about the algorithm behind it. use ''/** \brief comment */''
   * '''return values''': all the return values have to be commented with ''\returns what it returns''
   * '''parameters''': every parameter has to be commented with ''\param paramName comment''

to test your comments, run make in the orxonox directory.[[BR]]
visit [source:/orxonox/trunk/src/proto_class.cc#HEAD code-file] and [source:/orxonox/trunk/src/proto_class.h#HEAD header-file] to see how it works. "	enhancement	new	minor	Old Orxonox tickets orx-v0	Doxygen