cvrNaming.h

/*
 * Copyright (C) 1998-2006
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


#ifndef _CVR_NAMING
#define _CVR_NAMING

/**

\page naming Naming Conventions in the CVR-Lib.

<table>
<tr><td><b>C++ Item</b></td>          <td><b>Name convention</b></td></tr>
<tr><td>class, struct, union</td>     <td>theClassName</td></tr>
<tr><td>inner&nbsp;type</td>          <td>inner<b>_</b>type</td></tr>
<tr><td>public&nbsp;attribute</td>    <td>publicAttribute</td></tr>
<tr><td>protected&nbsp;attribute</td> <td>protectedAttribute<b>_</b></td></tr>
<tr><td>private&nbsp;attribute</td>   <td>privateAttribute<b>_</b></td></tr>
<tr><td>class&nbsp;method</td>        <td>classMethod()</td></tr>
<tr><td>public method<br>
        to access inner attributes</td><td><b>get</b>ClassAttribute()<br>
                                                classAttribute()</td></tr>
<tr><td>public method<br>
        for complex computations</td> <td><b>seek</b>Something()<br>
                                          <b>search</b>Something()<br>
                                          <b>find</b>Something()<br>
                                          <b>compute</b>Something()<br>
                                          <b>generate</b>Something()<br>
                                          <b>calculate</b>Something()</td></tr>
<tr><td>enum</td>                     <td><b>e</b>EnumType</td></tr>
<tr><td>constant in enum</td>         <td><b>C</b>onstantInEnum</td></tr>
<tr><td>macro name</td>               <td><b>_CVR_</b>MACRO_NAME</td></tr>
</table>

*/

#endif