linse/sics
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Modified documentation to work with the tcl-dox doxygen filter.

Browse Source 
r2147 | ffr | 2007-09-04 09:02:59 +1000 (Tue, 04 Sep 2007) | 2 lines
This commit is contained in:
Ferdi Franceschini
2007-09-04 09:02:59 +10:00
committed by Douglas Clowes
parent 69afaec27e
commit e33a7cf971
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
site_ansto/instrument/config/hipadaba/hipadaba_configuration_common.tcl
View File

@@ -1,5 +1,6 @@
## \file hipadaba_configuration_common.tcl
# \brief Commands for building the hdb tree from sics object properties and an instrument dictionary.
##
# @file hipadaba_configuration_common.tcl
# @brief Commands for building the hdb tree from sics object properties and an instrument dictionary.
#
# hobj policy: data=false control=parent nxsave=false klass=parent
# subtree/group_path policy: data=parent control=parent nxsave=parent klass=parent
@@ -366,9 +367,10 @@ proc sobjtypeadd {hpath sobjtype given_klass} {
}
## \brief Remove empty instrument dictionary nodes
##
# @brief Remove empty instrument dictionary nodes
#
# \param instdict name of the instrument dictionary structure
# @param instdict name of the instrument dictionary structure
#
# Nodes which have no child nodes and no associated sics objects for the
# current instrument are removed.
@@ -410,12 +412,13 @@ proc prune {instdict} {
}
#
#TODO add data control nxsave nxtyp properties
##\brief Traverse the instrument dictionary and construct the hipadaba database.
##
# @brief Traverse the instrument dictionary and construct the hipadaba database.
#
# \param instDict name of the instrument dictionary structure
# @param instDict name of the instrument dictionary structure
#
# This command prunes the dictionary before building it.
# \see prune
# @see prune
proc buildHDB {instDict} {
upvar #0 $instDict dictionary
prune dictionary