/Documentation/CodingRules/ExampleClass.h
https://github.com/aivanov-cern/cmssw · C Header · 53 lines · 20 code · 14 blank · 19 comment · 0 complexity · 3c7dbe9ebb2db994063a3b3381427c62 MD5 · raw file
- #ifndef ExampleClass_H
- #define ExampleClass_H
- /** \class ExampleClass
- * An example of doxygen-documented class conforming to the CMS style rules.
- *
- * Features:<br>
- * -doxygen-style header (note the \class directive)<br>
- * -doxygen-like member function documentation<br>
- * -Few setters and getters
- *
- * $Date: $
- * $Revision: $
- * \author W. Woodpecker - CERN
- */
- #include <vector>
- class SomeAlgorithm;
- class ExampleClass {
- public:
- /// Constructor
- ExampleClass();
- /// Virtual Destructor
- virtual ~ExampleClass();
- /// A simple setter
- void setCount(int ticks);
- /// A simple getter
- int count() const;
- /// Another setter
- void setValues(const std::vector<float>& entries);
- /// A getter returning a const reference
- const std::vector<float>& values() const;
- /// A member function
- float computeMean() const;
- protected:
- private:
- int theCount; //< An int data member
- std::vector<float> theValues; //< A vector data member
- SomeAlgorithm * theAlgo; //< A pointer data member
- };
- #endif // ExampleClass_H