Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
terralib:exemplo1 [2008/04/02 12:43] 150.163.3.123 |
terralib:exemplo1 [2008/04/02 12:59] (current) 150.163.3.123 |
||
|---|---|---|---|
| Line 15: | Line 15: | ||
| - | /** \file TeTemplate.h | ||
| - | \brief This file contains an template example | ||
| - | \authot | ||
| - | */ | ||
| #ifndef TE_TEMPLATE_H | #ifndef TE_TEMPLATE_H | ||
| #define TE_TEMPLATE_H | #define TE_TEMPLATE_H | ||
| - | #define TE_MYDEFINE 1 | + | #define TE_MY_DEFINE 1 |
| // C includes | // C includes | ||
| Line 39: | Line 35: | ||
| class Foward; | class Foward; | ||
| - | /** \namespace TerraLib | + | //! TerraLib namespace |
| - | \brief This namespace contains .... | + | /*! |
| + | This namespace contains all TerraLib kernel definitions. | ||
| */ | */ | ||
| + | |||
| namespace TerraLib | namespace TerraLib | ||
| { | { | ||
| Line 47: | Line 45: | ||
| class TeFoward; | class TeFoward; | ||
| - | /** \class TeTemplate | + | |
| - | \brief A Template class | + | //! A example of TerraLib programming style |
| + | /*! | ||
| + | This class is an example of TerraLib programming style. | ||
| + | |||
| + | \version (?) | ||
| + | \author (?) | ||
| + | \sa | ||
| */ | */ | ||
| class TeTemplate | class TeTemplate | ||
| { | { | ||
| public: | public: | ||
| - | + | ||
| - | /** \brief Set the value of member myInt_ | + | //! Empty contructor |
| - | \param myInt the value to be assigned to myInt_ | + | TeTemplate(void); |
| - | */ | + | |
| - | void setMyInt(const int& myInt); | + | |
| - | /** \brief Get the value of member myInt_ | + | //! Set the value of member myInt_ |
| - | \return the value to be assigned to myInt_ | + | /*! |
| - | */ | + | \param myInt the value to be assigned to myInt_ member |
| - | const int& getMyInt() const; | + | */ |
| + | void setMyInt(const int& myInt); | ||
| - | const bool& isValid() const; | + | //! Get the value of member myInt_ |
| + | /*! | ||
| + | \return returns the value of the myInt_ member | ||
| + | */ | ||
| + | const int& getMyInt(void) const; | ||
| + | |||
| + | //! Verify if the object is valid | ||
| + | /*! | ||
| + | \return returns true if the object is valid, otherwise, return false | ||
| + | */ | ||
| + | const bool& isValid() const; | ||
| protected: | protected: | ||
| Line 71: | Line 84: | ||
| protected: | protected: | ||
| - | int myProtectedInt_; | + | //! My protected int member |
| + | int myProtectedInt_; | ||
| private: | private: | ||
| - | int myInt_; | + | //! My private int member |
| - | double myDouble_; | + | int myInt_; |
| - | std::string myString_; | + | //! My private double member |
| - | bool valid_; | + | double myDouble_; |
| - | TeClass* myClassPointer_; | + | //! My private string member |
| + | std::string myString_; | ||
| + | //! My private boolen member | ||
| + | bool valid_; | ||
| + | //! My private class pointer member | ||
| + | TeClass* myClassPointer_; | ||
| }; | }; | ||
