I want to generate the Ruby documentation with hanna template. How to do that? Or where can I download it if it's available at all? Using rdoc -o ~/doc --inline-source --line-numbers --format=html --template=hanna gives me docs with missing methods. It seems like it doesn't generate methods written in C. ...
Hi, I would like to know if anyone know of a good tool to auto generate documentation of an oracle 9i database schema. I did a reasearch and so far found DBSribe(www.leadum.com) but i'm having problem with it since it giving me an error when doing the document generation process. Any help will be appreciated. thanks in advance. ...
I have a Flash (AS3) component library that I'm distributing, and I want to make sure that it's fully documented for each release. One of the things I really liked about Microsoft's automatic doc generation for C# was that I could have my compiler generate warnings (on every compile) for any public member that wasn't documented in their ...
Anyone know of a wiki or wiki plugin that generates a PDF file or CHM file that spans the entire wiki? I would like to have control of the table of contents. I would like the internal and external links to work. Ideally allow for tweaking the output template, but that is not a deal-breaker. I want to generate content using WIKI synt...
Hello. I'm looking for a help/documentation generation tool which would satisfy such requirements: it should support xmldoc comment produced by c# compiler or (even better) directly support sandcastle it should support importing of MS Word documents. it should support creating links from conceptual documentation to reference documenta...
I have been looking into CruiseControl configuration recently (I'm a complete CC noob) and so far I understand that various XML reports generated by your build process (eg mbunit.xml, ncover.xml, fxcop.xml) can be shown in the dashboard by adding a reference to the xml to the following part of the ccnet.config: <publishers> <merge> <...
Hi guys, I'm new to the wonderful world of .net development, and I'm currently using c# 3.0 and I'm wondering is there any good/free/open source tool to auto generate documentation for the project that I work on based on the /// summary comments like or whatever the in thing it is for vs2008. As I recall back in .net 1.1 we used to use t...
I need to document a legacy database schema for a new employee and as there's no design document I'd like to generate one from the existing schema. As the tables are MyISAM the foregin key relationships won't produce a nice graph. I'm interested in producing a document showing the important tables, their columns, types and remarks. Are ...
This weekend I installed Windows 7 (brilliant!) and there I found this genious tool called Problem Steps Recorder. Apparently a tool that came with the beta bug reporting tool thingy. I am currently trying to document some application usages for other developers. (In this exact case, how to get Showplan XML Statistics in SQL Profiler an...
In the past I've used Doxygen for C and C++, but now I've been thrown on Fortran project and I would like to get a quick all encompassing look at the architecture. In the past I've found reverse engineering tools to be useful where no documentation of the architecture exists. So, is there a tool out there that will reverse engineer Fo...
I realise this may just be speculation, but I'd appreciate comments from anyone who has some insight into this. Something like MS Word COM add-in, or an OO bridge, or a custom implementation. The reason I want to know is that I want to provide basic online document editing (really basic, basically just rich text at this point) for a ph...
I need to document an application -- not the underlying source code. (I use Doxygen for the internal source code documentation.) What are good documentation tools for producing HTML Help files? I know about the HTML Help Workshop, but I'm not very good at editing HTML files. I was hoping for something more integrated with a WYSIWYG...
I am working on a small toy project who is getting more and more releases. Until now, the documentation was just a set of pages in the wordpress blog I setup for the project. However, as time passes, new releases are out and I should update the online documentation to match the most recent release. Unfortunately, if I do so, the docs fo...
Hello, I currently use an ActiveX control to print out an html document from a popup window without prompting the user. I've never liked this method and have finally got around to reconsidering the problem. I've decided to use a Java applet, and have already managed to get the promptless printing working. However, I've no experience w...
I'm wondering are there more current and active alternative tools to the Apache Forrest product for project documentation that developers are using?. It seems to be stuck in v0.8 release since 2007. I'm thinking about using the maven site via Ant to generate a HTML report with the various javadoc, pmd and findbug reports for my project....
I'd like to add parts of the source code to the XML documentation. I could copy & paste source code to some <code> elements, like this: /// <summary> /// Says hello world in a very basic way: /// <code> /// System.Console.WriteLine("Hello World!"); /// System.Console.WriteLine("Press any key to exit."); /// System.Console.ReadKey(...
I'm working on a project where a c++/cli library is being used primarily from a c# application. Is there any way to make the code comments in c++/cli visible to c# intellisence within visual studio? Assuming there isn't, what would be the best way to document the c++/cli code to enable its easier use from c# (and within c++/cli of cour...
For a very long time, when I have an error handler I make it report what Project, Module, and Procedure the error was thrown in. I have always accomplished this by simply storing their name via constants. I know that in a Class you get the name programmatically with TypeName(Me), but obviously that only gets me one out of three pieces o...
I want to write a technical book. What is a good way/software to write it? What is important to me, I want to be editing text, not fighting formating. So no word like systems. Automatic syntax highlighting. Templatable. A way for users to leave feedback on specific parts of the book. Like Djangobook Not a wiki. (I don't think a wiki i...
The software group I currently work in has recently decided to start documenting our codebase. The initial approach they have been taking was to use the built in triple slash /// method of documenting. A newer issue we began to find was that the result of running this through doxygen is a very nice representation of the codebase but fo...