Hi to all. Give me an example, that's you can describe as "well documented project on Rails", or "best practices of making documentation for Rails project" (with link to github, or other same site, if it possible). And, what tools do you prefer to use for writing documentation of your project? ...
I am working with a team that works on a very large software project, we have tons of Documentation that is written in MS WORD format with nohyperlinked indexes, no search ability. Everyday we waste our time trying to find the exact document or reference. I was thinking if there was way or even a professional tool that would convert al...
I've been writing a lot of VC++ 2008 / CLI software recently and am using the C#/CLI style documentation: /// <summary> /// Function the does stuff /// </summary> /// <param name="someParam">Specifies some option</param> /// <returns>true if it worked</returns> bool DoStuff( bool someParam ); I find myself re-typing those blocks quite...
We are developing a very complex eCommerce portal using asp.net c# and the client asked us to make the documentation very similar (look & feel) with ebay api documentation http://developer.ebay.com/DevZone/shopping/docs/CallRef/GetSingleItem.html Do you have any idea what kind of tool they are using and if not do you know anything that...
Hi, I am working in a project where we are using a custom scripting language. I am looking for a documentation system such as Doxygen so that I could process the many script files that have been developped with this scripting languages. My basic needs are: to generate automatic documentation, to extract the calls graphs and establish ...
If I have a REST based service written in the Symfony [symfony-project.org] framework (i.e. PHP), is there any decent tools/frameworks out there that will parse my code and generate API documentation? The Java based framework enunciate has documentation capabilities similar to what I need, you can view an example of this here: http://en...
Has anyone tried creating end user (potentially online, potentially to be printed) help/documentation out of your cucumber scenarios? Or taken screenshots for use in documentation using RSpec and Selenium RC's ability to do so? For Cucumber, I'm imagining something like: Scenario: If you want to add a link Given I am on the edit blog p...
Any experiences on how to document Entity Framework 4 based Database projects? There is the Document and Summary properties on the Entities, but if we want to regenerate the model from the database at some point, it will be lost! Is there some way to map documentation data inside SQL to the Entities in the EDMX file so it is safe. Sug...
How do you put additional information into a Mathematica package file, like parameter specification doctests/example usage? Up to now, I only found the ::usage string and some information on how to write documentation notebooks. I am looking for an option to generate these documentation notebooks from introspecting package files. ...
hi, need to convert a pdf file to a doc file. I found different type of example to generate pdf file but not got pdf to doc. please help me in this regard with good example or source code or guideline. ...
Hi guys, I known that it's more a state of art than a technical question, but I'm looking for some good templates to document model relation, validations, method for the models and controllers of my rails app. Are there any conventions/best practice/examples to do that ? Thanks all for your help ...
Hello. I've been developing for Visual Studio and C# for a long time. Now, I'm developing with XCode and Objective-C. On C# I can use /// <summary> to generate documentation. Is there any kind of mechanism like that on XCode to generate documentation? And what kind of comments should I use? Thank you. ...
I want to create a waterfall model. What do I need to do for that? What type of document are required for that? ...
After happily using open source software for many years I've figured it's time to give back. And since documentation is usually a weak point for many projects, plus my C# skills are not exactly in high demand in my corner of FLOSS land, I've figured I'll start with tutorials, etc. After the second tutorial for a burning tool, I already ...
How to automatically generate documentatation of stored procedures of SQL Server 2008 like doxygen does to codes? I read about hyperSQL but it doesn't work nice with Windows. Thanks! Gil. ...
I'm working on a fairly large project written in C. The idea was to build a library of modular blocks that can be reused across several platforms. Each module is associated with a word document in .docx format (huge pain to diff-merge). In these docs, an interface section is specified, listing datatypes and publicly accessible functions....
I want to generate a HTML-Documentation for my Javascript code. The comments in my code are written in a format, the Google Closure Compiler can use to optimize my code. Example: /** * Class for handling timing events. * * @param {number=} opt_interval Number of ms between ticks (Default: 1ms). * @param {Object=} opt_timerObject A...
I work in a location where a single person is responsible for creating and maintaining all stored procedures for SQL servers, and is the conduit between software developers and the database. There are a lot of stored procedures in place, and with a database diagram it is simple enough 90% of the time to figure out what the stored proced...
Do you know about a tool to easily create documentation for both Javascript and PHP code? Something that takes comments in code similar to the one shown below: /********************************************************** This fucntion does something special... param1: ... param2: RETURNED VALUES: ... **********************************...
I'm currently writing a web service using WCF in VB.NET. Previous web services I wrote used ASMX but I wanted to learn WCF and so far it's going well. I actually prefer the way WCF does things. One thing I miss however is the way that ASMX used to generate example SOAP requests and responses. It was like getting documentation for fre...