HFST: Documentation Guide

The purpose of this page is to collect information about things that we need to know in order to produce good documentation with Doxygen and KitWiki.

What we need to know in order to improve Doxygen output?

  • Special characters should be quoted. I guess backslash can be used to quote # and <.
  • We have still a problem with some files. Why line numbers and file references are not correct etc.
  • Doxygen output should be tested as follows:

What we need to know in order to improve Hfst-topics in KitWiki?

* There is HfstTerminology where both important terminological conventions and HFST-specific conventions should be documented.


-- AnssiYliJyra - 15 Aug 2008
Topic revision: r1 - 2008-08-15 - AnssiYliJyra
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback