Is there a documentation system which is simple, will generate some friendly, hyperlinked documentation, for any language through the use of comment indications? Such a system may merely be given regexes or patterns to recognise comments and then generate structure. I was going to write one but figured there must be one already. ...
I've got one really big .java class file that has a lot of members. How do I create HTML documentation for this so it shows me the members in order of appearance, without sorting by member type? (methods, constants and variables) For example if my Java code is: private int typeOfAction_1; // notice the order: 1,2,3.. public voi...
Which Doxygen option can completely disable sorting members by type (Private / Public / Method / Variable), and output members purely based on the order in which they were declared? ...
In C#, I can attach documentation for properties, methods, events, and so on, directly in the code using XML Documentation Comments. I know how to insert a reference to a particular method: <see cref="MethodName(TypeForArg1, TypeForArg2..)"/> Is there a way to insert a reference to a method group? Where I've got multiple overloads...
i have one php page which prints some information. Information is a table with some values dynamicaylly printed in table cells.Now instead of sending this page to browser i want the page to be exported to a word file.How can i do it? In short i have a page A.php . A.php contains a link to B.php. When the link on A.php is clicked i want ...
As we know UML contains 13 types of diagrams (structural and behavioral) before starting a software developement, we are in requirement and design phase so which diagram should be create and when? .. What should be the sequence of diagrams creation in UML in requirement and design phase? In fact if there is no rigid sequence then first...
This is an annoyance more than a problem. My project contains a number of autogenerated files (using mgmtclassgen.exe). When I generate the XML documentation, my beautifully commented library is plagued by xml documentation warnings from these autogen files. Is there a way to either a) suppress generating documentation for these files ...
Lately, I have been looking into Apache Forrest as a code documentation solution. From Apache's website, "Apache Forrest™ software is a publishing framework that transforms input from various sources into a unified presentation in one or more output formats. The modular and extensible plug-in architecture of Apache For...
I'm about to write an WebService / Restful API that I intend for public usage. I know that I'm probably opening a Pandora's box, but I'm looking for suggestions on the best documentation tools and practices. I'm going to write all the documentation [hooks] first, then code it later. This is personal, so free tools is really the only o...
Is there any free decent program to do code documentation for java?It's hard enough to get the coding project done and then need to spend time writing documentation as well.If you know, please tell me. ...
Hi, I have an API that inherits flash.display.Sprite .When I try to generate the ASDocs for the API, The ASdoc shows that my class inherits from flash.display.Sprite, but doesnt link or there is no click-able link to the Sprite's ASDoc. Can anyone tell me what I am missing. The command I am using in my ant script is <java jar="${asd...
For JSP and some JSF tags there is a tool called TLDdoc that generates JavaDoc-style documentation for the JSP and JSF tags. Does anybody know an equivalent for Facelets? There is a tool called facelets-doc that aims to support Facelets but either it's not finished, or the lack of documentation doesn't mention how to make it work. I ha...
Hi, I'm looking for an XSD Documentation Generator for .NET. Please, provide any references. Note: If it is available with source code that would be much better choice. Thanks. ...
We are using Stata to combine and analyze data for all of our agencies in a district each month. I'd like to somehow create reports of the data analysis automatically for these monthly reports. The report includes a summary table of the reported indicators, a couple of graphics of the key indicators, and an analysis table showing stati...
Are there any free tools available for generating ERDs from an existing MySQL database? I've been given the requirement to generate such documentation for a legacy database and would prefer to not have to do it by hand. ...
I'm wondering if there are any clear reasons to choose UmlGraph over APIViz for javadoc UML diagram generation in a Maven2 build. Are there any integration or features that one has over the other, they seem pretty similar? ...
I have a multimodule project that I want to deploy a site for, but it seems like my site deployment configuration is not being inherited by subproject child modules. parent moduleA moduleB On the filesystem they are located relative to each other: /parent/ /moduleA/ /moduleB/ When I run: mvn site-deploy -P documentation My...
Hello guys, I would like to do something like this : def main(): """ Display Information about a Google Calendar -u --user login Google Login -p --pass password Google Password -d --debug Set DEBUG = True -h --help Display this help """ print(__doc__) if __name__ == "__main...
Sphinx is a Python library to generate nice documentation from a set of ReST formatted text files. Not the tool used for full-text searching I'm also fully aware of doxygen / phpdoc tools. I'm trying to figure out if there is a way of using Sphinx to document php projects? or even any other non-python languages? http://sphinx.pocoo.or...
I need to create a chm style web-based help. Do you know any such utility? The product is developed on C# and it would be great the help is also developed on C#. Thanks. ...