Short: A Tool to extract source code docs Author: Fabio Falcucci Uploader: hijoe tin it (Fabio Falcucci) Type: dev/misc Version: 1.0 Architecture: i386-aros APP_NAME GetDoc APP_VERSION 1.0 APP_AUTHOR Fabio Falcucci aka Allanon (hijoe()tin.it) APP_RELEASE 13.06.2008 ----------------------------------------------------------------------------- +--------------+ | INSTALLATION |---------------------------------------------------------- +--------------+ To install the program, uncompress in a drawer of your choice and ensure that the provided fonts are installed on your system, if you wish, you can put the provided fonts in the program drawer. +--------------+ | INTRODUCTION |----------------------------------------------------------- +--------------+ is a tool that can be used to extract documentation stored in a source code file. The result of this operation is an AmigaGuide file with an index of all nodes defined inside the source code. You have to follow some simple rules described below: | SINGLE LINE TAGS | +------------------+ GetDoc supports the following tags to define some global informations: Define the application's name Define the application's version Define the application's author | MULTILINE TAGS | +----------------+ Multiline tags are used to define the starting position of a new section (node) all subsequent lines will be included in the defined node unless another node is defined or the current one is explicitly terminated. Here are the tags provided: Define a new node <-8<---> Terminate the current node | LINKS | +-------+ Inside a node section you can define links with the tag LINK followed by the name of a valid node. These links will be listed all together at the end of the node. +-------+ | NOTES |----------------------------------------------------------------- +-------+ The -8<--- tag is usefull when you are documenting functions because you can close the current node leaving out all code comments. Actually this tool is written with Hollywood in mind but can handle all languages that support single line comments. Default is <;> but you can switch the comment type using the interface of GetDoc. +------------------+ | GETDOC INTERFACE |------------------------------------------------------ +------------------+ The interface is minimalist, there is a box for the source file and one for the destination file, where your Amigaguide file will be saved. There are three more options: If you select this switch, when the process is terminated the guide will be opened. Remmber that if you select this option the program will try to open the guide with Multiview (SYS:utilities/Multiview) so this option is valid only for system that support/have Multiview. This switch is used to alphabetically sort the master index of all available nodes. Select here which type of single line comment you want to parse in the selected source code. When all is in place press the button and your Amigaguide file will be generated. +-------------+ | FINAL NOTES |------------------------------------------------------------ +-------------+ This tool was born because my need to have a simple tool to build documention for ScuiLib. Finally, GetDoc is written using Hollywood 3.1 and ScuiLib for the GUI. You can get more info and updates here: http://sdb.freeforums.org/ Comments and suggestions are welcome! Please report any bugs you may encounter. This program is free, please give me credits if you are using this tool to build your own documentation. This software is provided "as is", I'm not responsible for any data loss GetDoc may cause. --------------------------------------------------------------------------- Fabio Falcucci aka Allanon hijoe()tin.it --------------------------------------------------------------------------- Uploaded using: archives.aros-exec.org