CPUG To Do List

AMMA

• Authors to state whether their Class is big or small object in the Class description.
• Should authors of Classes/Libraries be forced to provide an example? Examples provided are linked into the automatic online documentation via ! example.
• Should AMMA executables be forced to use OptionC for parsing command line options, along with the Comment() function? Output from the executables are now used when generating automatic online documentation for executables.

GAMA

• Too much to mention!

Online Documentation

• PC Port Page needs to be updated by a member of the PC Port Team!
• DOCNODE Facility, awaits for Charles to add the new DOCNODE tag to defs.mk, to copy images/files specified on that line into the DocNode directory.

  All other necessary software updates have been already implemented. All doc*.eht files are generated and written to the DocNode directory.

• DocExe: To remove system calls, and replace via unix calls. Also to add feature which will wait for X amount of time, for executable to finish, and then proceeds (stops problems with executables that don't use OptionC).
• SORTING.
  • To have member functions sorted on the right hand list, on class pages.

    A more sophisticated sorting function needs to be written, so that inherited member functions, are listed after the member functions on the current Class.

  • Perceps & Doc Tools: Sorting.
    A sorting routine needs to be developed that is not case sensitive. For example, the libaries page, has cont3d listed afted VThread because it's in lower case. Also in respect to the above, it would be nice to have member functions sorted in a non-case sensitive way.
• ! docentry = "string"
  Currently if white spaces are before or after equal sign, then its ignored. Affects eht files only. To modify Auto/Index/ehtdocentry.flt
• ! example
  Currently allows only one example, may extend in future.
• !return : To be implemented?