Thread: Documentation: API Documentation

Results 1 to 3 of 3
  1. #1
    Banned Solokiller's Avatar
    Join Date
    Sep 2004
    Location
    Belgium
    Posts
    3,314

    Documentation: API Documentation

    API Documentation

    Attached to this post is the API documentation for Angelscript V1.0 Beta, included with Sven Co-op 5.0. This documentation contains all API classes, enums, global functions and properties, typedefs and funcdefs.

    This documentation is in a HTML format. Use index.html to get a list of all contents.

    If you wish to create your own documentation, whether in HTML or another format, add -as_outputdocs <filename> as a command line parameter to the game. When you start a server, the game will output all documentation in the KeyValues format to svencoop/filename.txt. You can then parse in the documentation and use it.

    Notes

    1. Some changes have been made to the API since the release of 5.0. These changes will be included with the next update.
    2. The CSS for this documentation is very bare bones. Improvements are always possible.
    Attached Files Attached Files

  2. #2
    Banned Solokiller's Avatar
    Join Date
    Sep 2004
    Location
    Belgium
    Posts
    3,314

    Re: Documentation: API Documentation

    Attached to this post is the latest version of the Angelscript API.

    Also attached is a program that can generate the HTML documentation from its Keyvalues format.

    Usage:
    Code:
    ASCompiler.exe -m generatedocumentation -if asdocs.txt -od docs
    -m specifies which mode to use. there is only the generatedocumentation mode.
    -if specifies an input file to read from. This must be the output from the -as_outputdocs command line parameter passed to the game.
    -od specifies the directory in which all HTML documentation is output. The directory is not created if it does not exist yet.

    The HTML specifies style.css as its style document.

    The source code for this program will be released soon, once it's been cleaned up a bit.
    Attached Files Attached Files

  3. #3
    Banned Solokiller's Avatar
    Join Date
    Sep 2004
    Location
    Belgium
    Posts
    3,314

    Re: Documentation: API Documentation

    I've pushed the source code for the documentation generator to a Github repository. The entire program has been overhauled to use a newer Keyvalues parser which is much faster than the old one, it also shares a codebase with another project so you'll see a lot more stuff in there:

    https://github.com/SamVanheer/HL_Tools

    Note that the codebase is still very much a work in progress, so you'll be seeing a lot of changes soon.

Posting Permissions

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