Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Like JavaDoc, but for Gosu
Gosu
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.idea
core
html
itype
src/gw/gosudoc
test
.gitignore
GosuDoc.iml
README
ToDo.txt

README

Not much to say yet. Start of a tool for generating JavaDoc like output for Gosu

ORGANIZATION

Three modules:
- core: core interfaces and types
- itype: implementations of core interfaces and types based on Gosu ITypes
- html: HTML generation based on core interfaces and types

One possibly confusing bit of design; in the html module all the core types are enhanced with companion objects via a Html property. For example if docSet is an IGosuDocSet (core object) then docSet.Html will return the companion object for a doc set, which provides methods for generating Html.

RUNNING GOSUDOC

There's a Main.gsp:

Main -sources <sourcedirs> -packages <packages> -output <outputdir>

Source directories and packages are comma separated.

TODO

Lots still to do - see the ToDo.txt file
Something went wrong with that request. Please try again.