https://github.com/presidentbeef/brat-doc

Simple documentation generation for Brat
https://github.com/presidentbeef/brat-doc

Last synced: about 1 month ago
JSON representation

Simple documentation generation for Brat

• Host: GitHub
• URL: https://github.com/presidentbeef/brat-doc
• Owner: presidentbeef
• Created: 2011-11-23T16:58:19.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2013-11-11T07:57:09.000Z (over 11 years ago)
• Last Synced: 2025-03-14T18:08:41.639Z (about 1 month ago)
• Homepage:
• Size: 105 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## brat-doc

*Work in Progress*

Scans special comments in Brat and Lua code to generate some documentation.

Doesn't do anything fancy.

## Format

### Lua

    -- Object:  [instance]

    -- Call: . []

    -- Returns: 

    --

    -- 

    --

    -- Example:

    --

    -- 

Only the `Object:` line is required.

Example:

    -- Object: string instance

    -- Call: string.reverse!

    -- Returns: string

    --

    -- Reverses a string.

    --

    -- Example:

    --

    -- "parts".reverse!

### Brat

    # Object:  [instance]

    # Call: . []

    # Returns: 

    #

    # 

    #

    # Example:

    #

    # 

Example:

    # Object: file

    # Call: file.read file_name

    # Returns: string

    #

    # Reads in contents of file into a string.