Skip to content
This repository has been archived by the owner on Jul 8, 2022. It is now read-only.

Commit

Permalink
Update Doxygen documentation (#544, #532)
Browse files Browse the repository at this point in the history
* Removed files which are no longer used by Doxygen

* Update Doxygen main page
Add a link to the Tango documentation
Replace deprecated ALIGN="CENTER" HTML code

* Remove some Doxygen warnings (#532)

* Fix tango_const.h file not found Doxygen warning (#532)

* Fix Doxygen warning related to FreeSans font (#532)

* Document undocumented methods (#532)
Remove some Doxygen warnings related to undocumented methods
Fix some typos in the Doxygen documentation
Fix some copy/paste errors in the Doxygen documentation

* Update broken links to IDL documentation in Doxygen documentation.
  • Loading branch information
bourtemb authored Mar 28, 2019
1 parent 2cc4a91 commit b76b006
Show file tree
Hide file tree
Showing 22 changed files with 770 additions and 747 deletions.
4 changes: 2 additions & 2 deletions cppapi/client/Database.h
Original file line number Diff line number Diff line change
Expand Up @@ -372,11 +372,11 @@ public :
* Get services list from database
*
* Query database for specified services. The vector of strings returned in the DbDatum
* object contains pair of strings <instance_name> followed by<device name>
* object contains pair of strings &lt;instance_name&gt; followed by &lt;device name&gt;.
* @code
* string servicename("HdbManager");
*
* DbDatum db_datum = db->get_services(servicename);
* DbDatum db_datum = db->get_device_service_list(servicename);
*
* vector<string> service_device_list;
* db_datum >> service_device_list;
Expand Down
400 changes: 199 additions & 201 deletions cppapi/client/doc.h

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions cppapi/doxygen/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -788,7 +788,7 @@ INPUT = @PROJECT_SOURCE_DIR@/cppapi/server/device.h \
@PROJECT_SOURCE_DIR@/cppapi/server/attrdesc.h \
@PROJECT_SOURCE_DIR@/cppapi/server/fwdattrdesc.h \
@PROJECT_SOURCE_DIR@/cppapi/server/pipedesc.h \
@PROJECT_SOURCE_DIR@/cppapi/server/tango_const.h \
@PROJECT_BINARY_DIR@/cppapi/server/tango_const.h \
@PROJECT_SOURCE_DIR@/cppapi/server/attribute.h \
@PROJECT_SOURCE_DIR@/cppapi/server/multiattribute.h \
@PROJECT_SOURCE_DIR@/cppapi/server/pollext.h \
Expand Down Expand Up @@ -2212,7 +2212,7 @@ DOT_NUM_THREADS = 0
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_FONTNAME = FreeSans
DOT_FONTNAME =

# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
Expand Down
Binary file removed cppapi/doxygen/alba.jpg
Binary file not shown.
Binary file removed cppapi/doxygen/elettra_logo.gif
Binary file not shown.
22 changes: 0 additions & 22 deletions cppapi/doxygen/footer.html

This file was deleted.

83 changes: 0 additions & 83 deletions cppapi/doxygen/header.html

This file was deleted.

Binary file removed cppapi/doxygen/logo_desy.gif
Binary file not shown.
Binary file removed cppapi/doxygen/soleil_logo.gif
Binary file not shown.
39 changes: 29 additions & 10 deletions cppapi/server/attrdesc.h
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ class Attr
public:

/**@name Constructors
* Two constructor are defined for this class */
* Two constructors are defined for this class */
//@{
/**
* Constructs a newly allocated Attr object.
Expand Down Expand Up @@ -410,14 +410,22 @@ class Attr
Tango::AttrWriteType w_type = Tango::READ,
const char *assoc = AssocWritNotSpec);

/**
* Constructs a newly allocated Attr object.
*
* @param name The attribute name
* @param disp The attribute display level
*
*/
Attr(const char *name,Tango::DispLevel disp = Tango::OPERATOR);

//@}

/**@name Destructor
* Only one desctructor is defined for this class */
* Only one destructor is defined for this class */
//@{
/**
* The object desctructor.
* The object destructor.
*/
virtual ~Attr();
//@}
Expand Down Expand Up @@ -678,14 +686,20 @@ class SpectrumAttr: public Attr
*/
SpectrumAttr(const char *name,long data_type,Tango::AttrWriteType w_type,long max_x,DispLevel level);

SpectrumAttr(const char *_n):Attr(_n) {}
/**
* Constructs a newly allocated SpectrumAttr object.
*
* @param name The attribute name
*
*/
SpectrumAttr(const char *name):Attr(name) {}
//@}

/**@name Destructor
* Only one desctructor is defined for this class */
* Only one destructor is defined for this class */
//@{
/**
* The object desctructor.
* The object destructor.
*/
~SpectrumAttr() {}
//@}
Expand Down Expand Up @@ -747,7 +761,6 @@ class ImageAttr: public SpectrumAttr
/**
* Constructs a newly allocated ImageAttr object.
* The attribute display level is set to OPERATOR.
* The attribute write type is set to READ
*
* @param name The attribute name
* @param data_type The attribute data type
Expand All @@ -774,7 +787,6 @@ class ImageAttr: public SpectrumAttr

/**
* Constructs a newly allocated ImageAttr object.
* The attribute write type is set to READ
*
* @param name The attribute name
* @param data_type The attribute data type
Expand All @@ -787,14 +799,21 @@ class ImageAttr: public SpectrumAttr
ImageAttr(const char *name,long data_type,Tango::AttrWriteType w_type,
long max_x, long max_y, Tango::DispLevel level);

/**
* Constructs a newly allocated ImageAttr object.
*
* @param name The attribute name
*
*/

ImageAttr(const char *name):SpectrumAttr(name) {}
//@}

/**@name Destructor
* Only one desctructor is defined for this class */
* Only one destructor is defined for this class */
//@{
/**
* The object desctructor.
* The object destructor.
*/
~ImageAttr() {}
//@}
Expand Down
Loading

0 comments on commit b76b006

Please sign in to comment.