Geek Answers Handbook

How to create documentation prepared for the media from comments and xml comments

Can anyone suggest a good workflow that

  • Regardless of the number of disparate tools that may be required
  • and how much manual labor would be to carry out,

can let me include my project documentation (reflection + xml comments) in the mediawiki syntax that I would then use to include in my wikia development team?

+4
source share
3 answers

Some manual labor will be involved, but it must be feasible using the resources described below.

My first thought was that I just did some kind of search engine, which I met http://www.mediawiki.org/wiki/Alternative_parsers . All these parsers seem to take the data and convert it to XML, not XML, and none of them are .NET-based, which may not be very important in the long run if there was no coding. Who knows, maybe something here is worth a look.

Then I found http://www.mediawiki.org/wiki/Manual:Importing_XML_dumps . I believe that if you can import data in XML format, then all you really need to know is that the schema allows you to reformat your data accordingly. The best thing is that there is a link on this page to http://www.mediawiki.org/wiki/Manual:XML_Import_file_manipulation_in_CSharp , a C # example, how to work with Media Wiki XML Import Files. As an example, we can only take a small step to create the classes necessary to generate the required xml from scratch and dump the data. Below is a link to the official schema documentation: http://www.mediawiki.org/xml/export-0.3.xsd .

Depending on whether you want to write PHP, or another option does not appear. You can write the XMLTransform extension referred to here: http://www.ehartwell.com/TechNotes/MediaWikiXmlExtension.htm . This site seems to say that you can save your XML in its native format and write your own XSL sheet to display the content in the desired format.

Good luck

+3
source

You can use sandcastle to create a web page from your source code http://documentation.sandcastle.codeplex.com

You must enable the XML generation of your projects in your project settings. The generated XML can be used in sandcastle to create some cool documentation, such as web pages.

+1
source

I would look at Doxygen , generate XML , and then process the resulting XML (XSLT or the [s] tool of your choice) into something suitable for your needs.

If you installed graphviz , Doxygen can use its dot tool to generate various charts . Here is an example (from KDE docs) of the class hierarchy diagram generated by Doxygen: http://api.kde.org/playground-api/graphics-apidocs/cirkuit/src/lib/html/inherits.html

Another, slightly less bright (from IBM): http://www.icu-project.org/apiref/icu4c/classUMemory.html

0
source

More articles:


All Articles