Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Item14191: first commit of new implementation
- Loading branch information
Showing
15 changed files
with
9,354 additions
and
0 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| %META:TOPICINFO{author="ProjectContributor" date="1426275622" format="1.1" version="1"}% | ||
| %META:TOPICPARENT{name="Plugins"}% | ||
| ---+!! Doxygen Plugin | ||
| <!-- | ||
| One line description, required for extensions repository catalog. | ||
| * Set SHORTDESCRIPTION = Plugin containing for linking to Doxygen-generated diagrams | ||
| --> | ||
|
|
||
| %SHORTDESCRIPTION% | ||
|
|
||
| %TOC% | ||
|
|
||
| ---++ Plugin Preferences | ||
|
|
||
| %X% *Note: This plugin does not read settings from this topic.* Copy the settings below to your %USERSWEB%.SitePreferences topic and remove the # if changes are required. These settings can be placed in %USERSWEB%.SitePreferences, WebPreferences, User topics, or any individual topic. Refer to [[%SYSTEMWEB%.PreferenceSettings][preference settings]] for more information. | ||
|
|
||
| <verbatim> | ||
| * #Set DOXYGENPLUGIN_CREATE_SUBDIRS = 0 | ||
| * #Set DOXYGENPLUGIN_CASE_SENSE_NAMES = 0 | ||
| </verbatim> | ||
|
|
||
| ---+++ Description of the settings | ||
|
|
||
| *All settings are prefixed with =DOXYGENPLUGIN_= as shown above* _The prefix is ommited from this table to improve layout._ | ||
|
|
||
| The settings that appear here are meant to be set the same as the Doxygen configuration used to produce the files being linked to. Only settings relevant to the generation of output files are supported. | ||
|
|
||
| *Note:* Doxygen documentation generated with SHORT_NAMES enabled can not be supported by this plugin as those names are generated using a counter that can't reliably be reproduced outside of =doxygen=. | ||
|
|
||
| | *Setting* | *Default* | *Description* | | ||
| | CREATE_SUBDIRS | 0 | Matches the setting of the same name in the Doxyfile configuration for Doxygen, i.e. a subdirectory hash is used to spread the output files out. | | ||
| | CASE_SENSE_NAMES | 0 | Matches the setting of the same name in the Doxyfile configuration for Doxygen, i.e. a subdirectory hash is used to spread the output files out. | | ||
|
|
||
| ---++ Macros | ||
|
|
||
| %INCLUDE{VarDOX}% | ||
| %INCLUDE{VarDOXYDOT}% | ||
|
|
||
| ---++ Configuration Settings | ||
|
|
||
| The following settings can be defined in configure (admin interface): | ||
|
|
||
| | *Setting* | *Description* | *Default* | | ||
| | {Plugins}{DoxygenPlugin}{Root} | The top-level URL for the Doxygen documents | none (blank) | | ||
|
|
||
| See DOXYDOT above for an explanation as to how this is used. | ||
|
|
||
| ---++ Plugin Installation Instructions | ||
| You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server. | ||
|
|
||
| ---+++ Installation | ||
| Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install". | ||
|
|
||
| If you have any problems, or if the extension isn't available in =configure=, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help. | ||
|
|
||
| ---+++ Dependencies | ||
| This plug-in does not require any additional modules or tools beyond the base Foswiki install and core Perl packages, however, the plug-in is not useful unless you are generating Doxygen documentation and making it available via the web. | ||
|
|
||
| Linking to !PlantUML diagrams requires an updated Doxygen. Support for auto-generated !PlantUML diagrams has not yet been integrated as of Doxygen 1.8.10. Please see the attached patch files if this function is desired. To apply the patch and build Doxygen, do the following for 1.8.9.1: | ||
| <pre> | ||
| [/tmp]$ tar -xzf doxygen-1.8.9.1.src.tar.gz | ||
| [/tmp]$ cd doxygen-1.8.9.1 | ||
| [/tmp]$ patch -p1 <../doxygen-1.8.9.1-table-plantuml.patch | ||
| [/tmp/doxygen-1.8.9.1]$ ./configure --prefix /usr/local | ||
| [/tmp/doxygen-1.8.9.1]$ make | ||
| [/tmp/doxygen-1.8.9.1]$ sudo make install | ||
| [/tmp/doxygen-1.8.9.1]$ cd .. | ||
| [/tmp]$ rm -rf doxygen-1.8.9.1 | ||
| </pre> | ||
|
|
||
| or for 1.8.10: | ||
| <pre> | ||
| [/tmp]$ tar xzvf doxygen-1.8.10.src.tar.gz | ||
| [/tmp]$ cd doxygen-1.8.10 | ||
| [/tmp/doxygen-1.8.10]$ patch -p1 <../doxygen-1.8.10-table-plantuml.patch | ||
| </pre> | ||
| The remaining steps are taken from http://www.doxygen.com/install.html (consult this page for building instructions for other platforms). | ||
| <pre> | ||
| [/tmp/doxygen-1.8.10]$ mkdir build | ||
| [/tmp/doxygen-1.8.10]$ cd build | ||
| [/tmp/doxygen-1.8.10]$ cmake -G "Unix Makefiles" .. | ||
| [/tmp/doxygen-1.8.10]$ make | ||
| [/tmp/doxygen-1.8.10]$ sudo make install | ||
| </pre> | ||
|
|
||
| ---++ Plugin Info | ||
|
|
||
| | Change History: | <!-- versions below in reverse order --> | | ||
| | 13 Aug 2015 | 1.0.0 Initial release | | ||
|
|
||
|
|
||
|
|
||
| %META:FORM{name="PackageForm"}% | ||
| %META:FIELD{name="Author" title="Author" value="Foswiki:Main.JohnKnutson"}% | ||
| %META:FIELD{name="Version" title="Version" value="v1.0.0"}% | ||
| %META:FIELD{name="Release" title="Release" value="1.0.0"}% | ||
| %META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/DoxygenPlugin"}% | ||
| %META:FIELD{name="Copyright" title="Copyright" value="© 2015, Applied Research Laboratories, the University of Texas at Austin"}% | ||
| %META:FIELD{name="License" title="License" value="[[%25ATTACHURLPATH%25/COPYING.txt][GPLv3]]"}% | ||
| %META:FIELD{name="Home" title="Home" value="http://foswiki.org/Extensions/DoxygenPlugin"}% | ||
| %META:FIELD{name="Support" title="Support" value="http://foswiki.org/Support/DoxygenPlugin"}% | ||
| %META:FILEATTACHMENT{name="COPYING.txt" attachment="COPYING.txt" attr="" comment="GNU General Public License v3" date="1417819886" path="COPYING.txt" size="35147" user="ProjectContributor" version="1"}% | ||
| %META:FILEATTACHMENT{name="doxygen-1.8.9.1-table-plantuml.patch" attachment="doxygen-1.8.9.1-table-plantuml.patch" attr="" comment="Add support for mark-down table cell spans and PlantUML class diagrams to Doxygen 1.8.9.1" date="1417819886" path="doxygen-1.8.9.1-table-plantuml.patch" size="131085" user="ProjectContributor" version="1"}% | ||
| %META:FILEATTACHMENT{name="doxygen-1.8.10-table-plantuml.patch" attachment="doxygen-1.8.10-table-plantuml.patch" attr="" comment="Add support for mark-down table cell spans and PlantUML class diagrams to Doxygen 1.8.10" date="1417819886" path="doxygen-1.8.10-table-plantuml.patch" size="" user="ProjectContributor" version="1"}% |
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,31 @@ | ||
| %META:TOPICPARENT{name="DoxygenPlugin"}% | ||
| #VarDOX | ||
| ---+++ DOX{...} -- renders a URL for a Doxygen class diagram | ||
| * Parameters: | ||
| | *Parameter* | *Description* | *Default* | | ||
| | | Name of structure to link to | none, required parameter | | ||
| | subdir | A simple subdirectory from the root | no subdirectory | | ||
| | subdirs | Equivalent to CREATE_SUBDIRS parameter to Doxygen | DOXYGENPLUGIN_CREATE_SUBDIRS preference setting | | ||
| | casesense | Equivalent to CASE_SENSE_NAMES parameter to Doxygen | DOXYGENPLUGIN_CASE_SENSE_NAMES preference setting | | ||
| | stype | Structure type, e.g. "class", "struct", "union", etc. | class | | ||
| | extension | File extension for Doxygen document. | .html | | ||
|
|
||
| This macro renders to a simple text string that is the concatenation of the following elements: | ||
| * =$Foswiki::cfg{Plugins}{DoxygenPlugin}{Root}= | ||
| * =subdir= | ||
| * =stype= | ||
| * _DEFAULT_ (this is the unnamed argument to the macro) | ||
| * =extension= | ||
|
|
||
| *Note:* For security reasons, =subdir= only allows alphanumeric characters and underlines. This helps prevent malicious URLs from being generated. | ||
|
|
||
| *Note:* The URL is processed through the Doxygen character escaping algorithm, which replaces potentially problematic characters with coded text. | ||
|
|
||
| An example: | ||
| <verbatim>%DOX{"std::string" subdirs="1" subdir="stdcpp" casesense="0" stype="class"}%</verbatim> | ||
|
|
||
| Would generate (with the "Root" configuration item unset): | ||
| <verbatim>/stdcpp/d8/d29/classstd_1_1string.html</verbatim> | ||
|
|
||
| or, with the Root set to "<nop>http://www.google.com": | ||
| <verbatim>http://www.google.com/stdcpp/d8/d29/classstd_1_1string.html</verbatim> |
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,38 @@ | ||
| %META:TOPICPARENT{name="DoxygenPlugin"}% | ||
| #VarDOXYDOT | ||
| ---+++ DOXYDOT{...} -- renders a URL for a Doxygen class diagram | ||
| * Parameters: | ||
| | *Parameter* | *Description* | *Default* | | ||
| | | Name of structure to link to | none, required parameter | | ||
| | subdir | A simple subdirectory from the root | no subdirectory | | ||
| | subdirs | Equivalent to CREATE_SUBDIRS parameter to Doxygen | DOXYGENPLUGIN_CREATE_SUBDIRS preference setting | | ||
| | casesense | Equivalent to CASE_SENSE_NAMES parameter to Doxygen | DOXYGENPLUGIN_CASE_SENSE_NAMES preference setting | | ||
| | stype | Structure type, e.g. "class", "struct", "union", etc. | class | | ||
| | gtype | Type of diagram being linked to, "coll" (collaboration) or "inherit" (inheritance) | coll | | ||
| | style | Graph type, e.g. "graph", "puml" | graph (is used for Graphviz-generated diagrams while "puml" is used for !PlantUML-generated diagrams) | | ||
| | format | Format of the image files being linked to, e.g. "png", "svg", etc. | png | | ||
|
|
||
| This macro renders to a simple text string that is the concatenation of the following elements: | ||
| * =$Foswiki::cfg{Plugins}{DoxygenPlugin}{Root}= | ||
| * =subdir= | ||
| * =stype= | ||
| * _DEFAULT_ (this is the unnamed argument to the macro) | ||
| * "_" | ||
| * =gtype= | ||
| * "_" | ||
| * =style= | ||
| * "." | ||
| * =format= | ||
|
|
||
| *Note:* For security reasons, =subdir= only allows alphanumeric characters and underlines. This helps prevent malicious URLs from being generated. | ||
|
|
||
| *Note:* The URL is processed through the Doxygen character escaping algorithm, which replaces potentially problematic characters with coded text. | ||
|
|
||
| An example: | ||
| <verbatim>%DOXYDOT{"std::string" subdirs="1" subdir="stdcpp" casesense="0" stype="class" gtype="inherit" style="graph" format="png"}%</verbatim> | ||
|
|
||
| Would generate (with the "Root" configuration item unset): | ||
| <verbatim>/stdcpp/classstd_1_1string_inherit_graph.png</verbatim> | ||
|
|
||
| or, with the Root set to "<nop>http://www.google.com": | ||
| <verbatim>http://www.google.com/stdcpp/classstd_1_1string_inherit_graph.png</verbatim> |
Oops, something went wrong.