[NeXus-definitions-tickets] [NeXusDefinitions] #270: start each base class documentation with one-line summary

NeXus Base Classes and Instrument Definitions noreply at nexusformat.org
Mon Mar 3 13:02:46 GMT 2014


#270: start each base class documentation with one-line summary
-------------------------+----------------------------------------
 Reporter:  Pete Jemian  |      Owner:  Pete Jemian
     Type:  enhancement  |     Status:  new
 Priority:  minor        |  Milestone:
Component:  general      |   Keywords:  documentation summary NXDL
-------------------------+----------------------------------------
 Propose to start the documentation of each base class (and other NXDL
 files, too) with a one-line summary.  With that, then the page that lists
 all the base classes together at the start of the base class documentation
 in the manual, could show this summary.  This page:

 http://download.nexusformat.org/doc/html/classes/base_classes/index.html

 will become much more informative for the community and still be fully
 generated from source file.

-- 
Ticket URL: <http://trac.nexusformat.org/definitions/ticket/270>
NeXus Base Classes and Instrument Definitions <http://www.nexusformat.org/>
NeXus Base Classes and Instrument Definitions



More information about the NeXus-definitions-tickets mailing list