(anonymous IP: 3.138.126.51,352) | ||||||||||||||
| ||||||||||||||
Audio (96) Datatype (15) Demo (50) Development (247) Document (62) Driver (19) Emulation (62) Game (529) Graphics (224) Library (22) Network (62) Office (21) Utility (250) Video (18) Total files: 1677 Full index file Recent index file Part of aros exec |
[Show comments] [Show snapshots] [Show videos] [Show content] [Replace file] Robodoc is based on the AutoDocs program written some time ago by Commodore. The idea is to include for every function a standard header containing all sorts of information about that procedure/function. An AutoDocs program will extract those headers from the source file and put them in a autodocs-file. This way you can include the program documentation in the source code and is it not necessary to maintain two documents. Robodoc is such a program, however Robodoc has several additions. For one it can generate the documentation in different formats, ASCII, HTML, RTF, LaTex, and AmigaGuide. Another feature is that it can fully automatically create links within the document, and to other documents. It is also possible to include parts of the source in you document, complete with links. For instance it is possible to include a complete subroutine, and have the function names in this subroutine point to their documentation. If you never have used AutoDoc or Robodoc before you might take a look at the example in the examples directory. These are two amigaguide files that contain the documentation generated with Robodoc of the Robodoc program itself. Robodoc can generate the documentation in five different formats: o ASCII format; The autodocs-file is just a plain ASCII text-file, this file is very closely related to the one that the original AutoDocs program would generated. o AmigaGuide format; This is a format used on the Amiga computers to view in a HyperText way a text-file. The AmigaGuide program is necessary to view the resulting autodocs-file. o HTML format; The autodocs-file will be written as a HTML-file (HyperText Markup Language), this format is used on the WWW-Internet. By using a Mosaic/Netscape program you view the documentation. o LaTex o RTF |
Copyright © 2005 - 2024 The AROS Archives All Rights Reserved |