Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- terralib:exemplo1 [2008/03/31 14:21] – created laercio
+++ terralib:exemplo1 [2008/04/02 15:59] (atual) – 150.163.3.123
@@ Linha 1: / Linha 1: @@
 <code cpp>
-/*
+/**********************
 Commun header
-*/
+**********************/
-/** 	\file TeTemplate.h
+/*!
-	\brief This file contains an template example
+  \file   TeTemplate.h
-	\authot
+  \brief  This file contains an template example
+  This file can be used as reference for TerraLib programmers.
+  \author Karine  (karine@dpi.inpe.br)
+  \author Laércio (laercio@dpi.inpe.br)
 */
 #ifndef TE_TEMPLATE_H
 #define TE_TEMPLATE_H
-#define TE_MYDEFINE 1
+#define TE_MY_DEFINE 1
 // C includes
@@ Linha 28: / Linha 35: @@
 class Foward;
-/** 	\namespace TerraLib
+//!  TerraLib namespace
-	\brief	This namespace contains ....
+/*!
+  This namespace contains all TerraLib kernel definitions.
 */
 namespace TerraLib
 {
@@ Linha 36: / Linha 45: @@
 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
 {
   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:
@@ Linha 60: / Linha 84: @@
   protected:
-	int myProtectedInt_;
+    //! My protected int member
+    int myProtectedInt_;
   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_;
 };