<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="robots" content="index,follow"/>
<title>Documentation Rules</title>
<link rel="shortcut icon" href="favicon.ico">
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="travelccm.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-25250378-1']);
_gaq.push(['_setDomainName', 'none']);
_gaq.push(['_setAllowLinker', true]);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<script type="text/javascript"
src="https://apis.google.com/js/plusone.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table width="100%">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname"><a href="http://travel-ccm.sourceforge.net"><img height="45px" alt="TravelCCM Logo" src="travelccm_logo.png"></a>
 <span id="projectnumber">1.00.1</span>
</div>
<div id="projectbrief">C++ Travel Customer Choice Model Library</div>
</td>
<!-- begin SOURCEFORGE_CUSTOM-->
<td>
<div id="sflogo"><a href="http://travel-ccm.sourceforge.net"><img height="45px" alt="SourceForge Logo" src="sfx_logo.png"></a></div>
</td>
<!-- end SOURCEFORGE_CUSTOM-->
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('documentation.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Documentation Rules </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="doc_general"></a>
General Rules</h1>
<p>All classes in IT++ should be properly documented with Doxygen comments in include (`.h') files. Source (`.cpp') files should be documented according to a normal standard for well documented C++ code.</p>
<p>An example of how the interface of a class shall be documented in IT++ is shown here:</p>
<pre class="fragment">/*!
* \brief Brief description of My_Class here
*
* Detailed description of My_Class here. With example code if needed.
*/
class My_Class {
public:
//! Default constructor
My_Class(void) { setup_done = false; }
/*!
* \brief Constructor that initializes the class with parameters
*
* Detailed description of the constructor here if needed
*
* \param[in] param1 Description of \a param1 here
* \param[in] param2 Description of \a param2 here
*/
My_Class(TYPE1 param1, TYPE2 param2) { setup(param1, param2); }
/*!
* \brief Setup function for My_Class
*
* Detailed description of the setup function here if needed
*
* \param[in] param1 Description of \a param1 here
* \param[in] param2 Description of \a param2 here
*/
void setup(TYPE1 param1, TYPE2 param2);
/*!
* \brief Brief description of member_function1
*
* Detailed description of member_function1 here if needed
*
* \param[in] param1 Description of \a param1 here
* \param[in] param2 Description of \a param2 here
* \param[in,out] param3 Description of \a param3 here
* \return Description of the return value here
*/
TYPE4 member_function1(TYPE1 param1, TYPE2 param2, TYPE3 &param3);
private:
bool setup_done; /*!< Variable that checks if the class is properly
initialized with parameters */
TYPE1 private_variable1; //!< Short description of private_variable1 here
TYPE2 private_variable2; //!< Short description of private_variable2 here
};
</pre><h1><a class="anchor" id="doc_header"></a>
File Header</h1>
<p>All files should start with the following header, which include Doxygen's <code>\file</code>, <code>\brief</code> and <code>\author</code> tags, <code>$Date$</code> and <code>$Revisions$</code> CVS tags, and a common copyright note:</p>
<pre class="fragment">/*!
* \file
* \brief Brief description of the file here
* \author Names of the authors who contributed to this code
*
* Detailed description of the file here if needed.
*
* $Date: 2005-12-13 12:27:39 +0100 (mar, 13 déc 2005) $
* $Revision: 93 $
*
* -------------------------------------------------------------------------
*
* IT++ - C++ library of mathematical, signal processing, speech processing,
* and communications classes and functions
*
* Copyright (C) 1995-2005 (see AUTHORS file for a list of contributors)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* -------------------------------------------------------------------------
*/
</pre><h1><a class="anchor" id="doc_groups"></a>
Grouping Various Parts</h1>
<p>All functions must be added to a Doxygen group in order to appear in the documentation. The following code example defines the group <code>`my_group'</code>:</p>
<pre class="fragment">/*!
* \defgroup my_group Brief description of the group here
*
* Detailed description of the group here
*/
</pre><p>The following example shows how to document the function <code>`my_function'</code> and how to add it to the group <code>`my_group'</code>:</p>
<pre class="fragment">/*!
* \brief Brief description of my_function here
* \ingroup my_group
*
* Detailed description of my_function here
*
* \param[in] param1 Description of \a param1 here
* \param[in] param2 Description of \a param2 here
* \return Description of the return value here
*/
TYPE3 my_function(TYPE1 param1, TYPE2 &param2);
</pre> </div></div><!-- contents -->
</div><!-- doc-content -->
<li class="footer">Generated on Wed May 22 2013 21:19:39 for TravelCCM by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a>
1.8.3.1
</li>
<li class="footer">
<a href="http://sourceforge.net/projects/travel-ccm"><img class="footer" src="http://sflogo.sourceforge.net/sflogo.php?group_id=261639&type=12&format=.png" alt="SourceForge Logo"></a>
</li>
</ul>
</div>
</body>
</html>
