nsf / library / lib

doc-tools.xotcl

Clone Tools

Stats

Commits this week: 0
Total Committers: 4
Last Commit: 14 Oct
Commits this week: 0

Lines of code count not available

Commit Activity

Commits By Day In Week
52 week commits volume
Commits By Day In Week
Commits by day
Commits By Day In Week
Commits by hour
Commits By Hour In Day
Commit calendar
 

Most active committers (90 days)

loading
loading
  • last updated 17 hours ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
Tuesday 03 Aug 2010
11:55 pm

Gustaf Neumann <neumann@wu-wien.ac.at>

- changed "require next" to "... nx" - changed "require next::test" to "... nx::test" - changed "require next::doc" to "... nx::doc"

Options
    • -11
    • +11
    ./doc-tools.xotcl
  2. … 33 more files in changeset.
Thursday 29 Jul 2010
2:18 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- I created a first draft of the nx language manual, based on the new next::doc facilities. It is still incomplete, but demonstrates the use of next::doc for authoring code documentation.

To re-create the language reference (which is not yet integrated into

the build environment), run:

./nextsh tests/doc.xotcl

You will then find an output directory "NextLanguageCore" in your

/tmp/ directory.

- The next::doc comments which are sourced for generating the manual

can be found in generic/gentclAPI.decls and

generic/predefined.xotcl. I tried to add most comments to the

former, as the complexity of the predefined script does not comfort

documentation comments (and vice versa).

- Applied many fixes to the templates (based on the needs of the

language reference)

Options
    • -18
    • +36
    ./doc-tools.xotcl
  2. … 9 more files in changeset.
Wednesday 28 Jul 2010
10:59 am

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Added a placeholder logo image, to replace the YUI one for the time being - Provided for giving some version information at either the project or package level

Options
    • -1
    • +4
    ./doc-tools.xotcl
  2. … 4 more files in changeset.
10:10 am

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Fixed search box and autocompletion support (for packages and objects) - I allow for selecting/deselecting structural features set "private" ("deprecated" remains to be done) - I added the generation of links between documentation entities based on {{...}} markers. Any marker (code as well as links) can now be used in both description and parts sections.

Options
    • -19
    • +88
    ./doc-tools.xotcl
10:00 am

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Fixed search box and autocompletion support (for packages and objects) - I allow for selecting/deselecting structural features set "private" ("deprecated" remains to be done) - I added the generation of links between documentation entities based on {{...}} markers. Any marker (code as well as links) can now be used in both description and parts sections.

Options
    • -19
    • +91
    ./doc-tools.xotcl
  2. … 3 more files in changeset.
Tuesday 27 Jul 2010
10:02 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Adding basic support for subcommands (a @subcommand part type; formerly @variant) - Introducing comment reuse and cross-linkage along the class hierarchy upwards ("subclass of ...", showing inherited attributes and methods; using a @superclass attribute) - Amending the documentation of @param and @return with "type" information (checkoptions, constraints, defaults) - Showing both per-class and per-object methods - I now allow for inline- and out-of-line (block) code snippets in the description sections, based on wiki-like {{{...}}} marker annotation (same as in scaladoc2). - Adding support for newline representations in description sections (for a more convenient formatting). - Some bugfixes (e.g., @object-method did not work outside of an initcmd) - Started refactoring the entity tracing procedure (moving from [namespace import] resolution to mixin-based creation tracing)

Options
    • -81
    • +376
    ./doc-tools.xotcl
  2. … 3 more files in changeset.
10:02 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Adding basic support for subcommands (a @subcommand part type; formerly @variant) - Introducing comment reuse and cross-linkage along the class hierarchy upwards ("subclass of ...", showing inherited attributes and methods; using a @superclass attribute) - Amending the documentation of @param and @return with "type" information (checkoptions, constraints, defaults) - Showing both per-class and per-object methods - I now allow for inline- and out-of-line (block) code snippets in the description sections, based on wiki-like {{{...}}} marker annotation (same as in scaladoc2). - Adding support for newline representations in description sections (for a more convenient formatting). - Some bugfixes (e.g., @object-method did not work outside of an initcmd) - Started refactoring the entity tracing procedure (moving from [namespace import] resolution to mixin-based creation tracing)

Options
    • -81
    • +376
    ./doc-tools.xotcl
  2. … 3 more files in changeset.
Friday 18 Jun 2010
12:13 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Added a first set of documentation templates, based on the the TemplateData engine and the YUI doc styles available from http://yuilibrary.com/downloads/ (see library/lib/doc-assets/*.tmpl.html) - Added a @project entity class, which will become the root concept in a documentation hierarchy. For now, it only serves for some auxiliary purposes when processing the doc templates. - Continued documenting the next::doc package for testing purposes.

Options
    • -16
    • +122
    ./doc-tools.xotcl
  2. … 12 more files in changeset.
Wednesday 16 Jun 2010
7:31 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- I made sure that the existing HtmlRenderer infrastructure remains functional - Added a simplistic templating machinery (see TemplateData), based on cascading [subst] calls in per-object evals (assuming the nonleaf mode) and a basic templating instruction set (i.e., "let", "for", as well as "?" representing if-elseif-else blocks and "include" for composing template fragments). This will help me to transpose the YUI doc templates more easily (and split them up into template fragments). Also, it will allow future documentation writers to provide custom templates or modifications of existing ones. This was somehow inspired by Kristoffer Lawson "templating engine" in his Spindle web framework, which is solely based on Tcl namespaces, however.

Options
    • -35
    • +134
    ./doc-tools.xotcl
  2. … 1 more file in changeset.
Monday 14 Jun 2010
5:54 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Removed @attribute parts and realise them as @param parts which are parts of @object parts - Renamed PartAttribute->get_part() to require_part() - The line scanner now stores all comment lines as list by using [split] at an early stage to improve the robustness when line strings are fed to list-specific commands.

Options
    • -108
    • +63
    ./doc-tools.xotcl
  2. … 1 more file in changeset.
11:28 am

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Introduced a PartClass meta-class which seconds Part and its subclasses (for a uniform id generation etc.) - Removed the kludge around new_from_attribute(), there is now a canonical new(). - "scope" turned into a property of PartAttributes and, as such, of the association (slot) objects managing parts. this more closely resembles the idea of per-class and per-object interfaces. in turn, parts now contain a navigatable association to their managing part attributes (e.g., to resolve their scope). - Adding some basic exception-catching infrastructure too better differentiate between error conditions (style violation, invalid tags, arbitrary errors emerging from the parsing machinery). Adjusting and extending the test suite. - Simplified/generalised the parser's tag dispatcher; also, there is no a general @doc tag which allows to add documentation lines as tagged parts, rather than a distinct doc block - Removed the tagged_entity mechanisms and per-tag forwards on EntityClass - Documentation blocks may now contain intermediate space lines (by adding a space->text transition to the parsing spec). - Adding basic support to trace script sources from [package req] calls, needs to be polished and refactored

Options
    • -163
    • +305
    ./doc-tools.xotcl
  2. … 1 more file in changeset.
Monday 31 May 2010
11:02 am

ssoberni <stefan.sobernig@wu-wien.ac.at>

- Renamed EntityFactory to EntityClass - Introduced PartAttribute for managing entity-part associations, they also protect against duplicate entries - Added NextAttribute (though it should fuse with parameter entities in the end) - Completed basic support for embedded (initcmd) and freestanding (script): This multi-stage processing introduces a precedence order between the commenting levels (script < initcmd < method bodies). - Renamed most entity classes using their tag equivalent (@object, ...) - Introduced offset feature for the comment line scanner (offsets are used to select embedded comment blocks, e.g., in initcmds or method bodies) - Parsing of arbitrary scripts is now realised in a child interp - Introduced qualified entity names (e.g., @attribute Bar#a1) and per-object scope (through a scope prefix in tags, e.g., @object-method) - Did some cleanup and extended the test suite

Options
    • -391
    • +505
    ./doc-tools.xotcl
  2. … 1 more file in changeset.
Friday 21 May 2010
3:54 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

Finished and tested the rewrite of the scanning&parsing front-end for the doc processor. Remains to be integrated with the intermediate @ notation (basics are already working)

Options
    • -179
    • +258
    ./doc-tools.xotcl
  2. … 1 more file in changeset.
Wednesday 12 May 2010
2:34 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

Upgrading to the ::nx::* namespace renaming

Options
    • -30
    • +30
    ./doc-tools.xotcl
  2. … 2 more files in changeset.
2:18 pm

ssoberni <stefan.sobernig@wu-wien.ac.at>

tests/doc.xotcl

Options
    • -129
    • +480
    ./doc-tools.xotcl
  2. … 5 more files in changeset.
Tuesday 06 Apr 2010
3:56 pm

Gustaf A. Neumann <neumann@imac.lan>

- first checkin of doc-tools

Options
    • -0
    • +541
    ./doc-tools.xotcl
  2. … 5 more files in changeset.