documentation-generation

.NET - WCF - Building Documentation

Hi I've built a WCF Service using the Web Service Software Factory (www.codeplex.com/servicefactory). I'm trying to make a CHM help file for users of the web service. When I build a help file (using Sandcastle) the help file doesn't match the interface displayed to users. Let's take the case of a method in the service called CustomerG...

Documenting Interfaces and their implementation

Hi, I'm decorating my C# code with comments so I can produce HTML help files. I often declare and document interfaces. But classes implementing those interfaces can throw specific exceptions depending on the implementation. Sometimes, the client is only aware of the interfaces he's using. Should I document my interfaces by adding the ...

How can I convert an RTF file to a pdf file?

How can I convert an RTF file to a PDF one? I have the adobe PDF printer, should I use it? If so, how can I programmatically access it? ...

Are there documentation tools for SOAP web services?

Many tools are available for web service designing, programming and testing, commercial and free. But what is available in the area of documentation? Are there tools which can parse a WSDL and then generate a 'human-readable' documentation in HTML (or PDF)? ...

Need to write a script working under Win32 to put the tags in place for documentation automatically C++/C#

Hello, We are managing a C++/C# library and we noticed that many classes and functions were left undocumented. We thought about writing a script which would parse the code to look for undocumented classes and method to produce a list of undocumented classes/methods/functions. We would like, as well, the script to put the dOxygen tags ...

Documentation Framework like JavaDoc for Objective C

Does Objective C have a documentation framework similar to JavaDoc where documentation can be generated from the source code? ...

Widely accepted methods for documenting PHP source code in an auto-doc way?

I'm new to PHP, and my current job requires me to pick up the language at an extremely quick pace. I'm a documentation stickler. I even like to write documentation. I'm familiar with accepted documentation syntax and tools for a handful of languages. This is not the case for PHP. I know there are always multiple methods for writing do...

Does Visual Studio have an option to generate html documentation for Javadoc-style comments?

Does Visual Studio have an option to generate html documentation for Javadoc-style comments? If so, what steps are necessary to accomplish this? In BlueJ there is an option to translate Javadoc-style comments into an html file. Like the following picture shows for Java using BlueJ I want to do the same with Visual Studio : ...

C documentation-generator tool

Greetings Is there any free software that can take C source files and generating documentation using them? Thanks ...

wiki/docbook/latex documentation template system

Hi. I'm searching for a documentation template system or rather will be creating one. It should support the following features: Create output in PDF and HTML Support for large & complicated (LaTeX) formulas References between documents Bibliographies Templates will be filled by a Python script I've tried LaTeX with various TeX-to-HTM...

Problem with generating XPS documents with images in a WCF class library

I have a Silverlight application which uses a web service in order to create XPS documents. The document templates are created as XAML controls in a WCF class library. public void GenerateXPS() { Type typeofControl = Type.GetType(DOCUMENT_GENERATOR_NAMESPACE + "." + ControlTypeName, true); FrameworkElement control = (FrameworkE...

Is there a tool which allows easy writing of documentation from an XML schema?

My application uses an XML file of some complexity for configuration. It's not much - about two dozen elements - but still non-trivial. Currently I'm writing XML schema for it, and was wondering if there was a tool which would generate documentation from this schema? Something human-readable that can be used by a person who has to write...

Tools to generate a database diagram/ER diagram from existing Oracle database?

Looking for tools (windows platform) to genereate ER diagram (or similar) from an existing Oracle database. Any good tools out there that are free to use or low cost? ...

Documentation from XML Doc in VS

Hello. Tell me, please, is it possible to generate from standard XML Doc in Visual Studio a proper documentation? With exports from xml into user-friendly look? ...

PHP 5.3 Documentor?

Hello, I was wondering if there is a documentation solution available that supports PHP 5.3. We are having two problems with phpDocumentor. First, it lacks 5.3 support. Second, it requires too much memory when used on our codebase. Could anyone suggest viable alternatives to phpDocumentor? Thank you! ...

Automatic documentation from PHP code.

OK I know there's PhpDocumentor for generating documentation from php code. It seems it hasnt been updated in a long time (but maybe they figure its mostly feature complete). While this might be good for documenting things for other programmers, it doesn't seem well suited for documenting the external "API" of a web service. IE, if I'...

Does Perl have something like Java/PHP Docs?

Does Perl have a Perl Docs generator? Something like Java Docs or PHP Documenter? ...

Information architecture for document repositories

Hi, I've been tasked with re-designing the architecture of my division's document repositories. We currently have hundreds of documents across multiple SharePoint servers and would like to consolidate them under one repository that will allow users to easily find and update their docs. Can you recommend any resources to help me in t...

Tool to Scan Code Comments, and convert to Standard Format

I'm working on a C project that has seen many different authors and many different documentation styles. I'm a big fan of doyxgen and other documentation generations tools, and I would like to migrate this project to use one of these systems. Is anybody aware of a tool that can scan source code comments for keywords like "Description",...

Possible to fix/disable member groups FAIL when using Doxygen?

I develop an open-source Objective-C framework, and I use Doxygen to generate the documentation (http://dysart.cs.byu.edu/CHDataStructures). Overall, Doxygen does a nice job, but I have a perennial annoyance that I can't figure out for the life of me. I use the \name command and Member Groups to group methods by task (these Apple docs s...