Changeset 63 in pacpusframework for trunk


Ignore:
Timestamp:
01/09/13 17:38:19 (11 years ago)
Author:
Marek Kurdej
Message:

Documentation: file info.

Location:
trunk/include/Pacpus/kernel
Files:
11 edited

Legend:

Unmodified
Added
Removed
  • trunk/include/Pacpus/kernel/ComponentBase.h

    r62 r63  
    55/// @author  Marek Kurdej <firstname.surname@utc.fr>
    66/// @author  Samuel Gosselin <firstname.surname@utc.fr>
    7 /// @date    Month, Year
     7/// @date    February, 2006
    88/// @version $Id$
    99/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
    10 /// @brief Brief description.
     10/// @brief Generic ComponentBase class. This is an abstract class.
    1111///
    1212/// Detailed description.
     13/// @todo        - see if some methods can be private with ComponentManager
     14///              friendship
     15///              - include the copy of Xml node in param here
     16///              - see if there is a possibility to avoid the constraint
     17///              on parameters in the constructor of derived class
    1318
    1419#ifndef DEF_PACPUS_COMPONENTBASE_H
  • trunk/include/Pacpus/kernel/ComponentFactory.h

    r62 r63  
    33//
    44/// @author  Gerald Dherbomez <firstname.surname@utc.fr>
    5 /// @date    Month, Year
     5/// @date    February, 2006
    66/// @version $Id$
    77/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
    88/// @brief Brief description.
    99///
    10 /// Detailed description.
     10/// Purpose:    Template class ComponentFactory.
     11///             Use it to interface your components with the application.
    1112
    1213#ifndef DEF_PACPUS_COMPONENTFACTORY_H
  • trunk/include/Pacpus/kernel/ComponentFactoryBase.h

    r62 r63  
    33//
    44/// @author  Gerald Dherbomez <firstname.surname@utc.fr>
    5 /// @date    Month, Year
     5/// @date    February, 2006
    66/// @version $Id$
    77/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
    88/// @brief Brief description.
    99///
    10 /// Detailed description.
     10/// Purpose:    The ComponentFactoryBase class is used to provide an
     11///             abstract class to the template ComponentFactory
    1112
    1213#ifndef DEF_PACPUS_COMPONENTFACTORYBASE_H
  • trunk/include/Pacpus/kernel/ComponentManager.h

    r62 r63  
    33//
    44/// @author  Gerald Dherbomez <firstname.surname@utc.fr>
    5 /// @date    Month, Year
     5/// @date    January, 2006
    66/// @version $Id$
    77/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
    88/// @brief Brief description.
    99///
    10 /// Detailed description.
     10/// Purpose:     This class records the components and manages them
     11///              This class is a singleton
     12///              Use the static ComponentManager::create() function
     13///              to get a pointer on this object.
    1114
    1215#ifndef DEF_PACPUS_COMPONENTMANAGER_H
  • trunk/include/Pacpus/kernel/GenericObservable.h

    r62 r63  
    33//
    44/// @author  Stephane Bonnet <firstname.surname@utc.fr>
    5 /// @date    Month, 2012
     5/// @date    October, 2012
    66/// @version $Id$
    77/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
  • trunk/include/Pacpus/kernel/GenericObserverInterface.h

    r62 r63  
    33//
    44/// @author  Stephane Bonnet <firstname.surname@utc.fr>
    5 /// @date    Month, 2012
     5/// @date    October, 2012
    66/// @version $Id$
    77/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
  • trunk/include/Pacpus/kernel/Log.h

    r62 r63  
    33//
    44/// @author  Marek Kurdej <firstname.surname@utc.fr>
    5 /// @date    Month, 2012
     5/// @date    March, 2012
    66/// @version $Id$
    77/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
    8 /// @brief Brief description.
     8/// @brief Logging facility.
    99///
    1010/// Detailed description.
  • trunk/include/Pacpus/kernel/XmlComponentConfig.h

    r62 r63  
    22// CECILL-C License, Version 1.0.
    33//
    4 /// @author  Firstname Surname <firstname.surname@utc.fr>
    5 /// @date    Month, Year
     4/// @author  Gerald Dherbomez <firstname.surname@utc.fr>
     5/// @date    January, 2006
    66/// @version $Id$
    77/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
    88/// @brief Brief description.
    99///
    10 /// Detailed description.
     10/// Purpose:    definit la structure XML des paramètres de configuration
     11///             d'un composant
    1112
    1213#ifndef DEF_PACPUS_XMLCOMPONENTCONFIG_H
  • trunk/include/Pacpus/kernel/XmlConfigFile.h

    r62 r63  
    22// CECILL-C License, Version 1.0.
    33//
    4 /// @author  Firstname Surname <firstname.surname@utc.fr>
    5 /// @date    Month, Year
     4/// @author  Gerald Dherbomez <firstname.surname@utc.fr>
     5/// @date    January, 2006
    66/// @version $Id$
    77/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
    88/// @brief Brief description.
    99///
    10 /// Detailed description.
     10/// Purpose:    Classe permettant d'enregistrer un fichier de
     11///             configuration XML
     12///             Le fichier XML contient 2 sections :
     13///             - parameters : contient les parametres de l'application
     14///             - components : contient les composants
     15///             les composants ne peuvent pas avoir de noeuds fils
     16///
     17/// @todo       Creer une dtd qui permet de definir la liste des classes possibles
     18///             que peuvent prendre les composants
    1119
    1220#ifndef DEF_PACPUS_XMLCONFIGFILE_H
  • trunk/include/Pacpus/kernel/pacpus.h

    r62 r63  
    22// CECILL-C License, Version 1.0.
    33//
    4 /// @author  Firstname Surname <firstname.surname@utc.fr>
    5 /// @date    Month, Year
     4/// @author  Gerald Dherbomez <firstname.surname@utc.fr>
     5/// @author  Marek Kurdej <firstname.surname@utc.fr>
     6/// @date    February, 2006
    67/// @version $Id$
    78/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
  • trunk/include/Pacpus/kernel/road_time.h

    r62 r63  
    22// CECILL-C License, Version 1.0.
    33//
    4 /// @author  Firstname Surname <firstname.surname@utc.fr>
    5 /// @date    Month, Year
     4/// @author  Gerald Dherbomez <firstname.surname@utc.fr>
     5/// @date    January, 2006
    66/// @version $Id$
    77/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
Note: See TracChangeset for help on using the changeset viewer.