-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
ian
committed
Feb 7, 2009
1 parent
a0df580
commit 42f3b9e
Showing
9 changed files
with
251 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,39 @@ | ||
| CHXDOC INTEGRATION | ||
|
|
||
| HaxeUmlGen is loosely integrated with ChxDoc. ChxDoc is a source | ||
| documentation tool written by Russell Weir. ChxDoc is released under | ||
| a BSD style license. More info is available at | ||
| http://www.codeblackbox.com/. | ||
|
|
||
| The following modifications add an entry for "Class Diagram" to each | ||
| package. | ||
|
|
||
| To use ChxDoc and HaxeUmlGen together you must: | ||
| - Copy package.mtt and macros.mtt into the chxdoc templates directory. | ||
| - Compile with the -xml flag | ||
| - Run chxdoc | ||
| - Run haxeumlgen passing the "-c" flag and setting the output | ||
| directory to "uml" under the chxdoc output directory | ||
|
|
||
| For example, compiled with: | ||
| > haxe -xml ../doc/umlgen.xml -neko haxeumlgen.n -main umlgen.HaxeUmlGen | ||
|
|
||
| Run chxdoc with: | ||
| > chxdoc -o ../doc/html ../doc/umlgen.xml | ||
|
|
||
| Run haxeumlgen with: | ||
| > haxeumlgen -c -b "#101020" -f "#707080" -o ../doc/html/uml/ ../doc/umlgen.xml | ||
|
|
||
| Note that "-b" and "-c" are just to set the diagram colors to match | ||
| CHXDOC INTEGRATION | ||
|
|
||
| HaxeUmlGen can be loosely integrated with ChxDoc. ChxDoc is a source | ||
| documentation tool written by Russell Weir. ChxDoc is released under | ||
| a BSD style license. More info is available at | ||
| http://www.codeblackbox.com/. | ||
|
|
||
| The following modifications add an entry for "Class Diagram" to each | ||
| package. | ||
|
|
||
| To use ChxDoc and HaxeUmlGen together: | ||
|
|
||
| - Create a new templates directory for chxdoc, make it a copy of | ||
| [chxdoc]/templates/default. For example, | ||
|
|
||
| cp -R /usr/local/chxdoc/templates/default /usr/local/chxdoc/templates/mine | ||
|
|
||
|
|
||
| - Copy the template files in the directory into the new chxdoc | ||
| templates directory, overwriting the existing files. | ||
|
|
||
| cp *.mtt /usr/local/chxdoc/templates/mine | ||
|
|
||
| - Compile your source with the -xml flag. | ||
|
|
||
| haxe -xml ../doc/umlgen.xml -neko haxeumlgen.n -main umlgen.HaxeUmlGen | ||
|
|
||
| - Run chxdoc. | ||
|
|
||
| chxdoc -o ../doc/html ../doc/umlgen.xml | ||
|
|
||
| - Run haxeumlgen passing the "-c" flag and setting the output | ||
| directory to "uml" under the chxdoc output directory | ||
|
|
||
| haxeumlgen -c -b "#202030" -f "#707080" -o ../doc/html/uml/ ../doc/umlgen.xml | ||
|
|
||
|
|
||
| Note that "-b" and "-c" are just to set the diagram colors to match | ||
| the stylesheet I use. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/tr/html4/loose.dtd"> | ||
| <html> | ||
| <head> | ||
| ::raw build.comment:: | ||
| <title>::name:: (::config.title::)</title> | ||
| <meta name="date" content="::meta.date::" /> | ||
| ::foreach kw meta.keywords:: | ||
| <meta name="keywords" content="::kw::" /> | ||
| ::end:: | ||
| <link rel="stylesheet" type="text/css" href="::meta.stylesheet::" /> | ||
| <script type="text/javascript"> | ||
| function windowTitle() | ||
| { | ||
| if (location.href.indexOf('is-external=true') == -1) { | ||
| parent.document.title="::name:: (::config.title::)"; | ||
| } | ||
| } | ||
| </script> | ||
| <noscript></noscript> | ||
| </head> | ||
| <body onload="windowTitle();"> | ||
| <script language="javascript" type="text/javascript" src="::rootRelative::../chxdoc.js"></script> | ||
| <div id="class-frame" class="type-frame"> | ||
| <!-- ======== START OF class DATA ======== --> | ||
| <h1 class="::type::">::nameDots::::raw params::</h1> | ||
| <dl> | ||
| <dt>type</dt> | ||
| <dd>::type::</dd> | ||
| ::if superClassHtml != null:: | ||
| <dt>extends</dt> | ||
| <dd>::raw superClassHtml::</dd> | ||
| ::end:: | ||
| ::if isPrivate:: | ||
| <dt>private</dt> | ||
| <dd>yes</dd> | ||
| ::end:: | ||
| ::if interfacesHtml.length > 0:: | ||
| <dt>implements</dt> | ||
| ::foreach i interfacesHtml:: | ||
| <dd>::raw i::</dd> | ||
| ::end:: | ||
| ::end:: | ||
|
|
||
| ::if module != null && module.length > 0:: | ||
| <dt>defined in</dt> | ||
| <dd>::module::</dd> | ||
| ::end:: | ||
| ::if subclasses.length > 0:: | ||
| <dt>subclasses</dt> | ||
| ::foreach sc subclasses:: | ||
| <dd><a href="::raw sc.href::">::raw sc.text::</a></dd> | ||
| ::end:: | ||
| ::end:: | ||
| ::if platforms.length > 0:: | ||
| <dt>available in</dt> | ||
| ::foreach p platforms:: | ||
| <dd>::p::</dd> | ||
| ::end:: | ||
| ::end:: | ||
| </dl> | ||
|
|
||
| <div class="doc">$$typeDocs()</div> | ||
|
|
||
|
|
||
| ::if staticVars.length > 0:: | ||
| <!-- ============ STATIC VAR DETAIL =========== --> | ||
| <div class="members-panel"> | ||
| <h2><a name="static_var_detail"></a>Static Variables</h2> | ||
| <div class="members"> | ||
| ::foreach f staticVars:: | ||
| <div class="member"> | ||
| <div class="header">$$varHeader(::f::)</div> | ||
| <div class="body">$$varDocs(::f::)</div> | ||
| $$showPlatforms(::f.platforms::) | ||
| </div> | ||
| ::end:: | ||
| </div> | ||
| </div> | ||
| ::end:: | ||
|
|
||
| ::if staticMethods.length > 0:: | ||
| <!-- ============ STATIC METHOD DETAIL ========== --> | ||
| <div class="members-panel"> | ||
| <h2><a name="function_detail"></a>Static Methods</h2> | ||
| <div class="members"> | ||
| ::foreach m staticMethods:: | ||
| <div class="member"> | ||
| <div class="header">$$methodHeader(::m::)</div> | ||
| <div class="body">$$methodDocs(::m::)</div> | ||
| $$showPlatforms(::m.platforms::) | ||
| </div> | ||
| ::end:: | ||
| </div> | ||
| </div> | ||
| ::end:: | ||
|
|
||
| ::if constructor != null:: | ||
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | ||
| <div class="members-panel"> | ||
| <h2><a name="constructor_detail"></a>Constructor</h2> | ||
| <div class="members"> | ||
| <div class="member"> | ||
| <div class="header"> | ||
| <a name="::raw constructor.name::()"></a>$$showAccess(::constructor::)<span class="name">::raw constructor.name:: </span>(::if constructor.args != null::::raw constructor.args::::end::) | ||
| </div> | ||
| <div class="body">$$methodDocs(::constructor::)</div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ::end:: | ||
|
|
||
| ::if vars.length > 0:: | ||
| <!-- ============ FIELD field_detail =========== --> | ||
| <div class="members-panel"> | ||
| <h2><a name="member_var_detail"></a>Instance Variables | ||
| ::if superClasses.length > 0:: | ||
| <span id="hideInheritedVar" class="hideInheritedVar"> | ||
| <a class="showHideLink" href="#member_var_detail" onclick="javascript:showInherited('Var', false);"> | ||
| Hide Inherited | ||
| </a> | ||
| </span> | ||
| <span id="showInheritedVar" class="showInheritedVar"> | ||
| <a class="showHideLink" href="#member_var_detail" onclick="javascript:showInherited('Var', true);"> | ||
| Show Inherited | ||
| </a> | ||
| </span> | ||
| ::end:: | ||
| </h2> | ||
| <div class="members"> | ||
| ::foreach f vars:: | ||
| ::if f.isInherited == true:: | ||
| ::set spanClass = "hideInheritedVar":: | ||
| ::else:: | ||
| ::set spanClass = "showVar":: | ||
| ::end:: | ||
| <span class="::spanClass::"> | ||
| <div class="member"> | ||
| <div class="header">$$varHeader(::f::)</div> | ||
| <div class="body">$$varDocs(::f::)</div> | ||
| $$showPlatforms(::f.platforms::) | ||
| </div> | ||
| </span> | ||
| ::end:: | ||
| </div> | ||
| </div> | ||
| ::end:: | ||
|
|
||
| ::if methods.length > 0:: | ||
| <!-- ============ METHOD DETAIL ========== --> | ||
| <div class="members-panel"> | ||
| <h2><a name="method_detail"></a>Instance Methods | ||
| ::if superClasses.length > 0:: | ||
| <span id="hideInheritedMethod" class="hideInheritedMethod"> | ||
| <a class="showHideLink" href="#method_detail" onclick="javascript:showInherited('Method', false);"> | ||
| Hide Inherited | ||
| </a> | ||
| </span> | ||
| <span id="showInheritedMethod" class="showInheritedMethod"> | ||
| <a class="showHideLink" href="#method_detail" onclick="javascript:showInherited('Method', true);"> | ||
| Show Inherited | ||
| </a> | ||
| </span> | ||
| ::end:: | ||
| </h2> | ||
| <div class="members"> | ||
| ::foreach m methods:: | ||
| ::if m.isInherited == true:: | ||
| ::set spanClass = "hideInheritedMethod":: | ||
| ::else:: | ||
| ::set spanClass = "showMethod":: | ||
| ::end:: | ||
| <span class="::spanClass::"> | ||
| <div class="member"> | ||
| <div class="header">$$methodHeader(::m::)</div> | ||
| <div class="body">$$methodDocs(::m::)</div> | ||
| $$showPlatforms(::m.platforms::) | ||
| </div> | ||
| </span> | ||
| ::end:: | ||
| </div> | ||
| </div> | ||
| ::end:: | ||
| </div> | ||
| <!-- ========= END OF class DATA ========= --> | ||
| <hr /> | ||
| <a href="::rootRelative::../overview::config.htmlFileExtension::">Overview</a> | ||
| <hr /> | ||
| ::if config.footerText != null::<div id="footer">::raw config.footerText::</div>::end:: | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.