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

Commit b76b006

Browse files
authored
Update Doxygen documentation (#544, #532)
* 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.
1 parent 2cc4a91 commit b76b006

22 files changed

+770
-747
lines changed

cppapi/client/Database.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -372,11 +372,11 @@ public :
372372
* Get services list from database
373373
*
374374
* Query database for specified services. The vector of strings returned in the DbDatum
375-
* object contains pair of strings <instance_name> followed by<device name>
375+
* object contains pair of strings &lt;instance_name&gt; followed by &lt;device name&gt;.
376376
* @code
377377
* string servicename("HdbManager");
378378
*
379-
* DbDatum db_datum = db->get_services(servicename);
379+
* DbDatum db_datum = db->get_device_service_list(servicename);
380380
*
381381
* vector<string> service_device_list;
382382
* db_datum >> service_device_list;

cppapi/client/doc.h

Lines changed: 199 additions & 201 deletions
Large diffs are not rendered by default.

cppapi/doxygen/Doxyfile.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -788,7 +788,7 @@ INPUT = @PROJECT_SOURCE_DIR@/cppapi/server/device.h \
788788
@PROJECT_SOURCE_DIR@/cppapi/server/attrdesc.h \
789789
@PROJECT_SOURCE_DIR@/cppapi/server/fwdattrdesc.h \
790790
@PROJECT_SOURCE_DIR@/cppapi/server/pipedesc.h \
791-
@PROJECT_SOURCE_DIR@/cppapi/server/tango_const.h \
791+
@PROJECT_BINARY_DIR@/cppapi/server/tango_const.h \
792792
@PROJECT_SOURCE_DIR@/cppapi/server/attribute.h \
793793
@PROJECT_SOURCE_DIR@/cppapi/server/multiattribute.h \
794794
@PROJECT_SOURCE_DIR@/cppapi/server/pollext.h \
@@ -2212,7 +2212,7 @@ DOT_NUM_THREADS = 0
22122212
# The default value is: Helvetica.
22132213
# This tag requires that the tag HAVE_DOT is set to YES.
22142214

2215-
DOT_FONTNAME = FreeSans
2215+
DOT_FONTNAME =
22162216

22172217
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
22182218
# dot graphs.

cppapi/doxygen/alba.jpg

-2.13 KB
Binary file not shown.

cppapi/doxygen/elettra_logo.gif

-3.61 KB
Binary file not shown.

cppapi/doxygen/footer.html

Lines changed: 0 additions & 22 deletions
This file was deleted.

cppapi/doxygen/header.html

Lines changed: 0 additions & 83 deletions
This file was deleted.

cppapi/doxygen/logo_desy.gif

-1.56 KB
Binary file not shown.

cppapi/doxygen/soleil_logo.gif

-4.09 KB
Binary file not shown.

cppapi/server/attrdesc.h

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ class Attr
378378
public:
379379

380380
/**@name Constructors
381-
* Two constructor are defined for this class */
381+
* Two constructors are defined for this class */
382382
//@{
383383
/**
384384
* Constructs a newly allocated Attr object.
@@ -410,14 +410,22 @@ class Attr
410410
Tango::AttrWriteType w_type = Tango::READ,
411411
const char *assoc = AssocWritNotSpec);
412412

413+
/**
414+
* Constructs a newly allocated Attr object.
415+
*
416+
* @param name The attribute name
417+
* @param disp The attribute display level
418+
*
419+
*/
413420
Attr(const char *name,Tango::DispLevel disp = Tango::OPERATOR);
421+
414422
//@}
415423

416424
/**@name Destructor
417-
* Only one desctructor is defined for this class */
425+
* Only one destructor is defined for this class */
418426
//@{
419427
/**
420-
* The object desctructor.
428+
* The object destructor.
421429
*/
422430
virtual ~Attr();
423431
//@}
@@ -678,14 +686,20 @@ class SpectrumAttr: public Attr
678686
*/
679687
SpectrumAttr(const char *name,long data_type,Tango::AttrWriteType w_type,long max_x,DispLevel level);
680688

681-
SpectrumAttr(const char *_n):Attr(_n) {}
689+
/**
690+
* Constructs a newly allocated SpectrumAttr object.
691+
*
692+
* @param name The attribute name
693+
*
694+
*/
695+
SpectrumAttr(const char *name):Attr(name) {}
682696
//@}
683697

684698
/**@name Destructor
685-
* Only one desctructor is defined for this class */
699+
* Only one destructor is defined for this class */
686700
//@{
687701
/**
688-
* The object desctructor.
702+
* The object destructor.
689703
*/
690704
~SpectrumAttr() {}
691705
//@}
@@ -747,7 +761,6 @@ class ImageAttr: public SpectrumAttr
747761
/**
748762
* Constructs a newly allocated ImageAttr object.
749763
* The attribute display level is set to OPERATOR.
750-
* The attribute write type is set to READ
751764
*
752765
* @param name The attribute name
753766
* @param data_type The attribute data type
@@ -774,7 +787,6 @@ class ImageAttr: public SpectrumAttr
774787

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

802+
/**
803+
* Constructs a newly allocated ImageAttr object.
804+
*
805+
* @param name The attribute name
806+
*
807+
*/
808+
790809
ImageAttr(const char *name):SpectrumAttr(name) {}
791810
//@}
792811

793812
/**@name Destructor
794-
* Only one desctructor is defined for this class */
813+
* Only one destructor is defined for this class */
795814
//@{
796815
/**
797-
* The object desctructor.
816+
* The object destructor.
798817
*/
799818
~ImageAttr() {}
800819
//@}

0 commit comments

Comments
 (0)