nsf / tests

doc.tcl

Clone Tools

Stats

Commits this week: 0
Total Committers: 2
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 40 mins ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
Tuesday 26 Oct 2010
5:49 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- renamed nx regression tests .test to follow tcl conventions

Options
    • -1143
    • +0
    ./doc.tcl
  2. … 35 more files in changeset.
Friday 15 Oct 2010
3:55 pm

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

- Corrected the link generation for autocomplete/search entries in case of @use chaining and made them location-independent - Removed an superfluous div-closing tag in class.html.tmpl - Refactored the backend code for the auto-completion search box, separating the concerns of rendering the JS array of hashes and serialising entities into a dict representation. The latter allows to discriminate entity-specific rendering behaviour (together with the mixin layer facility). - Added the entity type (its pretty name) to the search results presented to the doc user. - Removed the unwanted "::"s from @project and @package names.

Options
    • -2
    • +2
    ./doc.tcl
  2. … 5 more files in changeset.
Tuesday 05 Oct 2010
4:43 pm

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

- Major refactoring based on a minimal Mixin Layer facility to modularise optional features (such as templating, documentation verification etc.) in layers of mixins to be applied to the entire entity hierarchy. - Rewrote the html templating machinery in terms of a mixin layer: NxDocRenderer - Used the new modularisation granularity to add @glossary-specific link rendering (following ideas from http://www.alistapart.com/articles/hattrick/) - Completed glossary support and added acronym handling - Added back references and ref counting for @glossary entries (to be displayed with the glossary lists) - I added the short-cut lists for selected part types of @class entities, namely @class-method and @class-attribute. - Fixed the rendering of methods and attributes for ascending alphabetical order.

Options
    • -6
    • +6
    ./doc.tcl
  2. … 7 more files in changeset.
Wednesday 29 Sep 2010
9:54 pm

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

- Minor revision of template files (to unify the naming of markup labels) - Removed occurrences of old [:let] - Use href() helper method to generate fragments of per-document ("local") anchor names - Introduced more pretty_name and pretty_plurals for part attributes - Make filename generation aware of the property of being a part or partof entity! - Revised the documentation of [::nsf::current] slightly - Adding setter ([:!let]) and getter ([:!get]) to the templating language, both being aware of @use chains. - Refactored the resolution behaviour for part levels, relative to a given entity, into a helper StructuredEntity->owned_parts(). Based on this helper, the navigation structures can be rendered on common grounds (e.g., drop-down search box, menus in th eleft bar) - Adding the attributes "pretty_name" and "pretty_plural" to part attribute slots (used for rendering section names in the nav menu etc.). - Adding a helper method href() to render the href attribute values of entity anchors (links, menu items, ...) - Unified the rendering of the selection data used by the drop-down box for the various entity_types, again, using the owned_parts() helper - Refactored the generation of navigation menu in the left bar into a proper template: leftbar.html.tmpl - Reflect recent naming changes (e.g., predefined.tcl -> nsf.tcl) - Adding support for documentation inheritance; first, fixed @command support for it - Refactored the upward resolution of partof entities into a central and shared facility (Entity->get_upward_path()) - Adjusting for changes in introspection interface (info.callable() -> info.lookup()) - Adding a first aliasing (@use) mechanism. Remains to be tested properly, though it works sufficiently for the known use cases. - Adding some safety checks to Tag->find() - Refactoring context->parse@tag to use the Tag->find() helper (now shared between tag creation and link resolution) - Tag path normalisation (expanding shortcuts, balanced list check, ...) went into Tag->normalise(). - Changed the [:link ...] mechansism ({{@someTag ...}}) to operate on the new tag notation. Added support for sub-method and sub-command link rendering (looks sufficient for the moment). - Changed the existing *.nxd companions to match these notational modifications.

Options
    • -35
    • +37
    ./doc.tcl
  2. … 10 more files in changeset.
Monday 13 Sep 2010
4:11 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- renamed "parameter" into "attributes" in nx - renamed "info parameter" into "info attributes" in nx - updated migration guide - fixed several common typos

Options
    • -1
    • +1
    ./doc.tcl
  2. … 13 more files in changeset.
8:59 am

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- changed "cls object method ..." and friends into "cls class-object method ..."

Options
    • -7
    • +7
    ./doc.tcl
  2. … 18 more files in changeset.
Wednesday 08 Sep 2010
5:14 pm

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

- Added support for companion documentation files (based on the file extension *.nxd) - Moved the nsf and nx documentation blocks in generic/predefined.nxd and library/nx/nx.nxd, respectively - Un-exported @param, provide two aliases @attribute and @parameter (in the respective contexts). - Changed the test suite and the two documentations to reflect the naming changes.

Options
    • -95
    • +100
    ./doc.tcl
  2. … 8 more files in changeset.
12:36 pm

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

- Added two new templates: method.html.tmpl and submethod.html.tmpl - Generalised the support for sub-commands and sub-methods, including a shortcut notation for tag lines. - Adding the special handling of initcmd blocks of attribute slots: They are processed as @param specifications of their owning (class) object. In a next step, I will limit this special handling to the first comment block only, while subsequent ones are evaluated in the context of the slot object itself. - Fixed an issue with cleaning up the processing-related mixin classes in the CommentBlockParser: As the nested notation of doc entities can conflict with relation slot forwarders (*::info::mixin vs. *::info mixin <add|delete>), I revert to using ::nsf::relation directly. - Fixed the default namespace resolution (still needs some review, once all use cases are figured out!) Changed nx and nsf documentation accordingly. - Add first doc text for Object->info() and its sub-methods (for testing purposes, merely) - Added an initial implementation for parsing level support. By introducing skipping axes into the tag notation (e.g., @..param), we can now differentiate between different scopes of applications for tags. This has a number of advantages: a) processing becomes more efficient (skip-level annotated tags can be identified early), b) we do not have maintain different tag labels for different parsing levels (e.g., @child-object vs. @object), ... - Parsing levels have to be maintained within the documentation processor and provided to the comment block parsers at work. This still has to be accomplished. - Adapted the naming scheme for qualifier tags (for now). Instead of "child" scopes, we coerce the entity names using namespace delimiters (this fits nested objects nicely) - Changed the resolution behaviour for dotted tag labels: Intermediate nodes (i.e., entities) are not allocated anymore, on the fly. Rather, it is a pure id resolution, except from the leaf element which is effectively initialised as a documentation entity. This has major implications: It requires partof entities to exist prior to any part entity. However, the id resolution work can later be reused when introducing the new tag notations into the link block markers in the templating engine (avoiding zombie and widely undescribed doc entities). - Started shifting id generation into part attributes (for the time being). Probably I will do so permanently to avoid the complexity in the various new() factories for doc entity types. - Adjusted the tests accordings and added many more on the navigatable tag notation. - Renamed EntityClass and PartClass into Tag and PartTag. The meta-class names so better reflect their purpose as entity factory classes, based on the tag notation scheme. Added a QualifierTag meta-class which marks tags (@class, @object, @command) which impose extra requirements when not being part of another entity (in particular, default namespace resolution). If not part of another entity, they represent *qualifying* language constructs, i.e. language constructs which help identify other elements (command -> subcommand, object -> nested object or method). - Started harmonising the entity class hierarchy (not ready cooked yet): Entity < StructuredEntity < ContainerEntity < @project < @method < @package < PartEntity < @object (@param) < @class < @command The most important change is that all entities (entity instances) can become parts, however, only a single entity class (@param) is critical about it.

Options
    • -195
    • +441
    ./doc.tcl
  2. … 7 more files in changeset.
Wednesday 01 Sep 2010
1:34 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- changed argument order on nsf::is to make it conformant with Tcl conventions - removed objectproperty, replaced it by ::nsf::is - move functionalizy of objectproperty to make "obj info is ..." more efficient

Options
    • -11
    • +11
    ./doc.tcl
  2. … 13 more files in changeset.
1:00 am

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

- Replaced the former "exception" handling mechanism by a simplified one. This speeds up e.g. the generation of the current nx.tcl documentation by 15-20%. - Adjusted the tests for the modified CommentBlockParser interface. - Implemented a first version of the revised tagline notation. Changed the documentation in nx.tcl and predefined.tcl accordingly. - Discriminate between parsing simple and complex part entities. In the simple case, multi-line part sections are not allowed anymore. - Adopted the recent changes in the object introspection interfaces

Options
    • -42
    • +131
    ./doc.tcl
  2. … 4 more files in changeset.
Monday 30 Aug 2010
2:34 pm

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

- Refactoring templating code: Separated generic and backend-specific templating behaviour into distinct classes: BaseTemplateData and NxDocTemplateData. Rewrote the getter logic for the @doc strings to retrieve different representations (as_text() and as_list()). - Multi-line block markers: To achieve this, I moved the handling of block markers into the template data classes. - Adjusted the tests for the changes ...

Options
    • -17
    • +17
    ./doc.tcl
  2. … 5 more files in changeset.
10:55 am

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

Temporarily fixed an issue with cleaning up comment section states set on an entity object. This needs to be improved and to be made more robust!

Options
    • -5
    • +6
    ./doc.tcl
  2. … 1 more file in changeset.
Friday 27 Aug 2010
3:27 pm

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

Adding tests for multi-line param descriptions

Options
    • -1
    • +18
    ./doc.tcl
Thursday 26 Aug 2010
5:10 pm

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

- Added an experimental gathering facility for part objects, relative to a given entity object. It returns a [dict] which allows to reuse the parts gathered throughout the templates rendering process. - Moved the process=@* methods to the doc object (this increases the cohesion). - Adjusted the current documentation artifacts for the changes (@object -> @class where applicable).

Options
    • -4
    • +17
    ./doc.tcl
  2. … 5 more files in changeset.
Wednesday 25 Aug 2010
10:41 am

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

- Started separating the documentation into four documentation projects, each with its own documentation artifact: nsf (predefined.tcl), nsl/nx (nx.tcl), xotcl (xotcl2.tcl), libraries (several?). - Removed documentation blocks from gentclAPI.decls - Added default namespace resolution for documentation entities. @project and @package can now specify a default namespace which is applied to all relative (not fully qualified) entity names. This avoids the redundant writing of longish qualified entity names. As a @project may contain several @packages, multiple default namespaces can be specified. - Added a distinct @class entity family. - @project and @package can now trace the creation of specified part entities (@class, @object, @command) to be structurally linked to them. - Fixed search box support for @command views - Excluded template files from output directories

Options
    • -35
    • +67
    ./doc.tcl
  2. … 8 more files in changeset.
Friday 20 Aug 2010
2:05 pm

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

- Accomplished major rewrite and cleanup of the comment block parser. The revised design allows us to express parsing states (context, description, part) as well as their substates reflecting the comment line processed (tag, text, space) directly. The design follows a METHODS-FOR-STATES strategy. Also, the parsing logic is now self-contained and is not interwoven with the class hierarchy documentation entities anymore (i.e., the former process() method of Entity and its subclasses). - The modal/reactive design of the comment block parser has been streamlined: There is a CommentBlockParser class which acts as the event source. The actual parsing is achieved by the mixin-refined entity objects by reacting upon the parsing events (process, parse, next). - Adjusted the tests in doc.tcl accordingly. - Changed occurrences of [info callable] to reflect the latest changes.

Options
    • -81
    • +84
    ./doc.tcl
  2. … 1 more file in changeset.
Friday 13 Aug 2010
12:14 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- adjusted path in documentation system for nx/nx.tcl

Options
    • -1
    • +1
    ./doc.tcl
Thursday 12 Aug 2010
7:44 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- made the "next scripting laguage" a own, loadable tcl package (currently named nx, name is subject of change) - predefined.tcl is now pretty minimal.

Options
    • -16
    • +16
    ./doc.tcl
  2. … 32 more files in changeset.
Tuesday 10 Aug 2010
8:42 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- updated migration guide, added section for callstack introspection - updated serializer for new names

Options
    • -4
    • +10
    ./doc.tcl
  2. … 3 more files in changeset.
7:59 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- xotcl.c: * new function GetObjectFromNsName() to obtail object or class from a fully qualified namespace name used in method handles (such as e.g. ::nx::core::classes::X) * new function MethodHandleObj() to return a tcl_obj containing the methodhandle * removed obsolete method getFullProcQualifier() * info methods obtain now object and/or class from fully qualified method names (method handles) if possible * return message handles in "current next", "current filterreg" and "... info filter ... -order", which can be used in "info method .... " for obtaining more details. * change all occurrances of "self" in next regression tests to current. - xotcl2.tcl * implemented "self" as a proc to provide extensibility and full backward compatibilty; this opens opportunity to replace now e.g. "self proc" by "current method", etc. * provide full compatibility for "self next", "self filterreg" and "... info filter ... -order", returning old-style multiword method handles (such as e.g. "::C instproc foo") - changed "next" to current in documentation framework and templates

Options
    • -3
    • +6
    ./doc.tcl
  2. … 19 more files in changeset.
Monday 09 Aug 2010
3:48 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- deactivated __next for now - iterated thought doc.tcl-TODOs - fixed path in invocation of xotcl doc script

Options
    • -2
    • +102
    ./doc.tcl
  2. … 11 more files in changeset.
Friday 06 Aug 2010
8:40 pm

Gustaf A. Neumann <neumann@Gustaf-A-Neumanns-iMac.local>

- renamed mk_predefined.xotcl -> mk_predefined.tcl - renamed predefined.xotcl -> predefined.tcl - additional subcommand "info method parametersyntax <methodname>" returns parameters in a syntax similar to the tcl man pages - added ability to pass syntax for forwarded methods via set ::nx::core::signature(::nx::Object-method-forward) (experimental) - fixed documentation system to work with actual version - added undocumented methods for quality control in documentation - added checks for documented, but unavailable methods in documentation - added comparison of documented parameters vs. actual parameters in documentation

Options
    • -0
    • +626
    ./doc.tcl
  2. … 17 more files in changeset.