Menu
▾
▴
[Stdair-svn] SF.net SVN: stdair:[245] trunk/stdair/stdair
|
From: <den...@us...> - 2010-07-26 14:49:11
|
Revision: 245
http://stdair.svn.sourceforge.net/stdair/?rev=245&view=rev
Author: denis_arnaud
Date: 2010-07-26 14:49:05 +0000 (Mon, 26 Jul 2010)
Log Message:
-----------
[Doc] Set up the comments in a few classes so that Doxygen better gets them.
Modified Paths:
--------------
trunk/stdair/stdair/STDAIR_Service.hpp
trunk/stdair/stdair/bom/BomContent.hpp
trunk/stdair/stdair/bom/BomKey.hpp
trunk/stdair/stdair/bom/BomStructure.hpp
trunk/stdair/stdair/bom/Inventory.hpp
trunk/stdair/stdair/bom/InventoryContent.hpp
Modified: trunk/stdair/stdair/STDAIR_Service.hpp
===================================================================
--- trunk/stdair/stdair/STDAIR_Service.hpp 2010-07-26 12:09:21 UTC (rev 244)
+++ trunk/stdair/stdair/STDAIR_Service.hpp 2010-07-26 14:49:05 UTC (rev 245)
@@ -1,3 +1,13 @@
+/**
+ * @brief Handle on the StdAir library context
+ * @author Anh Quan Nguyen <qua...@us...>
+ * @date 20/01/2010
+ * @detail StdAir aims at providing a clean API, and the corresponding
+ * C++ implementation, for the basis of Airline IT Business Object
+ * Model (BOM), that is, to be used by several other Open Source
+ * projects, such as RMOL and OpenTREP<br>
+ * Install the StdAir library for Airline IT Standard C++ fundaments.
+ */
#ifndef __STDAIR_SVC_STDAIR_SERVICE_HPP
#define __STDAIR_SVC_STDAIR_SERVICE_HPP
@@ -12,69 +22,103 @@
namespace stdair {
- // Forward declarations
+ /// Forward declarations
class BomRoot;
- /** Interface for the STDAIR Services. */
+ /**
+ * @brief Interface for the STDAIR Services
+ */
class STDAIR_Service {
public:
// ////////// Constructors and destructors //////////
- /** Constructor.
- <br>The init() method is called; see the corresponding documentation
- for more details.
- <br>Moreover, a reference on an output stream is given, so
- that log outputs can be directed onto that stream.
- @param const BasLogParams& Parameters for the output log stream. */
+ /**
+ * @brief Constructor.
+ * <br>The init() method is called; see the corresponding
+ * documentation for more details.
+ * <br>Moreover, a reference on an output stream is given, so
+ * that log outputs can be directed onto that stream.
+ * @param[in] const BasLogParams& Parameters for the output log stream.
+ */
STDAIR_Service (const BasLogParams&);
- /** Constructor.
- <br>The init() method is called; see the corresponding documentation
- for more details.
- <br>A reference on an output stream is given, so
- that log outputs can be directed onto that stream.
- <br>Moreover, database connection parameters are given, so
- that database requests can use the corresponding access.
- @param const BasLogParams& Parameters for the output log stream.
- @param const BasDBParams& Parameters for the database session. */
+ /**
+ * @brief Constructor.
+ * <br>The init() method is called; see the corresponding
+ * documentation for more details.
+ * <br>A reference on an output stream is given, so
+ * that log outputs can be directed onto that stream.
+ * <br>Moreover, database connection parameters are given, so
+ * that database requests can use the corresponding access.
+ * @param[in] const BasLogParams& Parameters for the output log stream.
+ * @param[in] const BasDBParams& Parameters for the database session.
+ */
STDAIR_Service (const BasLogParams&, const BasDBParams&);
- /** Destructor. */
+ /**
+ * @brief Destructor.
+ */
~STDAIR_Service();
// ///////////////// Getters ///////////////////
- /** Get a reference on the BomRoot object.
- <br>If the service context has not been initialised, that
- method throws an exception (failing assertion). */
+ /**
+ * @brief Get a reference on the BomRoot object.
+ * <br>If the service context has not been initialised, that
+ * method throws an exception (failing assertion).
+ * @param[out] BomRoot& Reference on the BomRoot.
+ */
BomRoot& getBomRoot () const {
return _bomRoot;
}
private:
// /////// Construction and Destruction helper methods ///////
- /** Default constructor. */
+ /**
+ * @brief Default constructor.
+ */
STDAIR_Service ();
- /** Default copy constructor. */
+
+ /**
+ * @brief Default copy constructor.
+ * @param[in] const STDAIR_Service& Reference on the STDAIR_Service handler
+ * to be copied.
+ */
STDAIR_Service (const STDAIR_Service&);
- /** Initialise the log. */
+
+ /**
+ * @brief Initialise the log.
+ * @param[in] const BasLogParams& Parameters for the output log stream.
+ */
void logInit (const BasLogParams&);
- /** Initialise the database session. */
+
+ /**
+ * @brief Initialise the database session.
+ * @param[in] const BasDBParams& Parameters for the database session.
+ */
void dbInit (const BasDBParams&);
- /** Initialise.
- <br>The static instance of the log service (Logger object) is created.
- <br>The static instance of the database session manager
- (DBSessionManager object) is created.
- <br>The static instance of the FacSupervisor object, itself referencing
- all the other objects (factories and BOM), is created.
- <br>As those three objects are static, there is no need to store them
- in any service context. However, some lock mechanism may be needed
- in order to secure the access to the corresponding resources. */
+
+ /**
+ * @brief Initialise.
+ * <br>The static instance of the log service (Logger object) is created.
+ * <br>The static instance of the database session manager
+ * (DBSessionManager object) is created.
+ * <br>The static instance of the FacSupervisor object, itself referencing
+ * all the other objects (factories and BOM), is created.
+ * <br>As those three objects are static, there is no need to store them
+ * in any service context. However, some lock mechanism may be needed
+ * in order to secure the access to the corresponding resources.
+ */
void init ();
- /** Finalise. */
+
+ /**
+ * @brief Finalise.
+ */
void finalise ();
private:
// /////////////// Attributes ///////////////
- /** Root of the BOM tree. */
+ /**
+ * @brief Root of the BOM tree.
+ */
BomRoot& _bomRoot;
};
}
Modified: trunk/stdair/stdair/bom/BomContent.hpp
===================================================================
--- trunk/stdair/stdair/bom/BomContent.hpp 2010-07-26 12:09:21 UTC (rev 244)
+++ trunk/stdair/stdair/bom/BomContent.hpp 2010-07-26 14:49:05 UTC (rev 245)
@@ -1,3 +1,8 @@
+/**
+ * @defgroup BomContent Content part of the Business Object Model (BOM)
+ * @author Anh Quan Nguyen <qua...@us...>
+ * @date 20/01/2010
+ */
#ifndef __STDAIR_BOM_BOMCONTENT_HPP
#define __STDAIR_BOM_BOMCONTENT_HPP
@@ -7,12 +12,14 @@
// STL
#include <iosfwd>
#include <string>
-// STDAIR
+// StdAir
#include <stdair/STDAIR_Types.hpp>
namespace stdair {
- /** Base class for the Business Object Model (BOM) layer. */
+ /**
+ * @brief Base class for the Business Object Model (BOM) layer
+ */
class BomContent {
friend class FacBomContent;
public:
Modified: trunk/stdair/stdair/bom/BomKey.hpp
===================================================================
--- trunk/stdair/stdair/bom/BomKey.hpp 2010-07-26 12:09:21 UTC (rev 244)
+++ trunk/stdair/stdair/bom/BomKey.hpp 2010-07-26 14:49:05 UTC (rev 245)
@@ -1,3 +1,9 @@
+/**
+ * @defgroup BomKey Part of the Business Object Model (BOM) handling
+ * (hash-like )keys
+ * @author Anh Quan Nguyen <qua...@us...>
+ * @date 20/01/2010
+ */
#ifndef __STDAIR_BOM_BOMKEY_HPP
#define __STDAIR_BOM_BOMKEY_HPP
@@ -12,31 +18,43 @@
namespace stdair {
- /** Base class for the keys of Business Object Model (BOM) layer.
- <br>Note that that key allows to differentiate two objects
- at the same level only. For instance, the segment-date key allows
- to differentiate two segment-dates under a given flight-date,
- but does not allow to differentiate two segemnt-dates in general. */
+ /**
+ * @brief Base class for the keys of Business Object Model (BOM) layer.
+ * <br>Note that that key allows to differentiate two objects
+ * at the same level only. For instance, the segment-date key allows
+ * to differentiate two segment-dates under a given flight-date,
+ * but does not allow to differentiate two segemnt-dates in general.
+ */
struct BomKey_T {
public:
// /////////// Display support methods /////////
- /** Dump a Business Object Key into an output stream.
- @param ostream& the output stream. */
+ /**
+ * @brief Dump a Business Object Key into an output stream.
+ * @param[inout] ostream& the output stream.
+ */
virtual void toStream (std::ostream& ioOut) const {}
- /** Read a Business Object Key from an input stream.
- @param istream& the input stream. */
+ /**
+ * @brief Read a Business Object Key from an input stream.
+ * @param[inout] istream& the input stream.
+ */
virtual void fromStream (std::istream& ioIn) {}
- /** Get the serialised version of the Business Object Key.
- <br>That string is unique, at the level of a given Business Object,
- when among children of a given parent Business Object.
- <br>For instance, "H" and "K" allow to differentiate among two
- marketing classes for the same segment-date. */
+ /**
+ * @brief Get the serialised version of the Business Object Key.
+ * <br>That string is unique, at the level of a given Business Object,
+ * when among children of a given parent Business Object.
+ * <br>For instance, "H" and "K" allow to differentiate among two
+ * marketing classes for the same segment-date.
+ * @param[out] const std::string The serialised version of the Business
+ * Object Key.
+ */
virtual const std::string toString() const { return std::string("Hello!"); }
- /** Default destructor. */
+ /**
+ * @brief Default destructor.
+ */
virtual ~BomKey_T() {}
};
Modified: trunk/stdair/stdair/bom/BomStructure.hpp
===================================================================
--- trunk/stdair/stdair/bom/BomStructure.hpp 2010-07-26 12:09:21 UTC (rev 244)
+++ trunk/stdair/stdair/bom/BomStructure.hpp 2010-07-26 14:49:05 UTC (rev 245)
@@ -1,3 +1,8 @@
+/**
+ * @defgroup BomStructure Structure part of the Business Object Model (BOM)
+ * @author Anh Quan Nguyen <qua...@us...>
+ * @date 20/01/2010
+ */
#ifndef __STDAIR_BOM_BOMSTRUCTURE_HPP
#define __STDAIR_BOM_BOMSTRUCTURE_HPP
@@ -12,7 +17,9 @@
namespace stdair {
- /** Base class for the Business Object Model (BOM) tree structure. */
+ /**
+ * @brief Base class for the Business Object Model (BOM) tree structure.
+ */
class BomStructure {
friend class FacBomStructure;
friend class FacBomContent;
Modified: trunk/stdair/stdair/bom/Inventory.hpp
===================================================================
--- trunk/stdair/stdair/bom/Inventory.hpp 2010-07-26 12:09:21 UTC (rev 244)
+++ trunk/stdair/stdair/bom/Inventory.hpp 2010-07-26 14:49:05 UTC (rev 245)
@@ -1,3 +1,6 @@
+/**
+ * @ingroup BomStructure
+ */
#ifndef __STDAIR_BOM_INVENTORY_HPP
#define __STDAIR_BOM_INVENTORY_HPP
@@ -18,6 +21,7 @@
#include <stdair/bom/FlightPeriodTypes.hpp>
namespace stdair {
+
// Forward declarations
class BomRoot;
class FlightDate;
@@ -26,8 +30,10 @@
struct FlightDateKey_T;
struct FlightPeriodKey_T;
- /** Class representing the actual functional/business content for
- an airline inventory. */
+ /**
+ * @brief Class representing the actual functional/business content for
+ * an airline inventory.
+ */
class Inventory : public InventoryContent {
friend class FacBomContent;
Modified: trunk/stdair/stdair/bom/InventoryContent.hpp
===================================================================
--- trunk/stdair/stdair/bom/InventoryContent.hpp 2010-07-26 12:09:21 UTC (rev 244)
+++ trunk/stdair/stdair/bom/InventoryContent.hpp 2010-07-26 14:49:05 UTC (rev 245)
@@ -1,3 +1,6 @@
+/**
+ * @ingroup BomContent
+ */
#ifndef __STDAIR_BOM_INVENTORYCONTENT_HPP
#define __STDAIR_BOM_INVENTORYCONTENT_HPP
@@ -4,15 +7,18 @@
// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
-// STDAIR
+// StdAir
#include <stdair/bom/BomContent.hpp>
#include <stdair/bom/InventoryKey.hpp>
namespace stdair {
- /** Class representing the actual attributes for an airline inventory. */
+ /**
+ * @brief Class representing the actual attributes for an airline inventory
+ */
class InventoryContent : public BomContent {
public :
+
// Type definitions
/** Definition allowing to retrieve the associated BOM key type. */
typedef InventoryKey_T Key_T;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
