#include <GlobalInclude>
#include "localinclude"
/**
* @class ClassName
* @brief Short class description
*
* Long class description
* Long class description line 2
*/
class ClassName{
public:
int publicFunctionName(int);
inline int privateVariableName(){ return m_privateVariableName; }
inline void setPrivateVariableName(const int &theValue){ m_privateVariableName = theValue; }
private:
void privateFunctionName();
int m_privateVariableName; ///< short variable description
int _otherStyleOfPrivateVariableName;
};
/**
* @brief Short description
*
* Long description
*
* @param argName description of argument
* @return description of value returned
*/
int ClassName::publicFunctionName(int argName){
int localVariableName;
if( true ){
localVariableName = _privateVariableName + 1;
}
return localVariableName;
}
#include <GlobalInclude>
#include "localinclude"
/**
* @class ClassName
* @brief Short class description
*
* Long class description
* Long class description line 2
*/
class ClassName{
public:
int publicFunctionName(int);
inline int privateVariableName(){ return m_privateVariableName; }
inline void setPrivateVariableName(const int &theValue){ m_privateVariableName = theValue; }
private:
void privateFunctionName();
int m_privateVariableName; ///< short variable description
int _otherStyleOfPrivateVariableName;
};
/**
* @brief Short description
*
* Long description
*
* @param argName description of argument
* @return description of value returned
*/
int ClassName::publicFunctionName(int argName){
int localVariableName;
if( true ){
localVariableName = _privateVariableName + 1;
}
return localVariableName;
}
To copy to clipboard, switch view to plain text mode
For C Linux Kernel code I prefer the lower_case_with_underscore_naming_convention
Bookmarks