Results 1 to 7 of 7

Thread: KeywordDocumenter, optional tool to document module keywords

Threaded View

Previous Post Previous Post   Next Post Next Post
  1. #1
    Super Moderator Petr Schreiber's Avatar
    Join Date
    Aug 2005
    Location
    Brno - Czech Republic
    Posts
    7,153
    Rep Power
    736

    KeywordDocumenter, optional tool to document module keywords

    This is work in progress tool for documenting your modules.

    Its description is available in ReadMe.TXT:
    Document revision from 27-02-2011

    KeywordDocumenter.tbasic
    =========================

    Tool to help with documenting keywords, while preserving "neutral" data format, post processable to HTML or other formats.

    How to use?

    - Fill description
    - Fill syntax
    - Choose return type or add your own
    - Press "Auto fill" to get prefilled template for parameters
    - Fill other fields
    - Press "Save", it will create file named after the keyword
    - Press "Clear all" and go for other keyword


    Make_All.bat
    ============

    This batch file, as its name says, will "Make all". That means it will first ask you for information such as name, version and support website for your library, and then it will automatically generate HTML files from your previously created keyword definitions.

    Once finished with documenting, run this file to generate HTML to HTMLOutput directory.
    To compose the final CHM help file, you need to download Microsoft HTML Help Workshop

    May the tool serve you well


    Petr

    UPDATED: 27-02-2011
    Attached Images Attached Images
    Attached Files Attached Files
    Last edited by Petr Schreiber; 27-02-2011 at 12:45.
    Learn 3D graphics with ThinBASIC, learn TBGL!
    Windows 10 64bit - Intel Core i5-3350P @ 3.1GHz - 16 GB RAM - NVIDIA GeForce GTX 1050 Ti 4GB

Similar Threads

  1. Replies: 1
    Last Post: 21-02-2007, 01:56

Members who have read this thread: 0

There are no members to list at the moment.

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •