dylan-lang / doctower Goto Github PK
View Code? Open in Web Editor NEWGenerate documentation from Dylan code comments
License: Other
Generate documentation from Dylan code comments
License: Other
################## ### Doctower ### ################## Doctower is a documentation generator. It can scan Dylan source files and automatically generate skeletal documentation and various indices. You can add more specific documentation to the Dylan source files directly, or write separate text files and various overview topics as desired. Markup capabilities include cross-references, verbatim text, images, footnotes, tables, and very nice organizational tools (including dedicated table of contents files). The markup is very unobtrusive, following common text-file conventions where possible. Doctower can output documentation in DITA XML format or in HTML format, and can include raw DITA or HTML markup within each topic. ### Development ### DOCTOWER IS STILL UNDER DEVELOPMENT. Only some of what I said above is true at the moment. If you want to help (and I can definitely use some), check out the TODO file and source-code comments, or ask me, |Agent, on IRC or e-mail to [email protected]. - I use 3-space tab stops. ### Directories ### code - Source code. Aside from "registry" and "ext", each directory is a library, and the directories within those are modules. thoughts - What passes for design documents. These contain some of my thought processes. I also have a notebook, which I cannot really upload. defaults - Prototype designs for HTML, CSS, and various generated elements. ### Making ### cd code dylan-compiler -build doctower-library
I generated the docs for the sql library as such:
~/Projects/Dylan/doctower/code/_build/bin/doctower -o /Users/rroland/temp/sql-docs -T /Users/rroland/Projects/Dylan/doctower/defaults /opt/opendylan-2013.1/sources/sql/*.lid
The resulting docs show all identifiers with a leading capitalized letter, like:
Sql, ,
I'll see if I can create a patch to add to this issue.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.