I have a file that is located at a different path at development time, however at the time of release it will be in a different location. The title of the documentation, after being generated, is set to the development path. Is it possible to manually set the path of the filename? What I mean about title: The structure of the documented...
Is there a gem or plugin, that can generate a Comments with columns names above the class definition in Active Record model? I'm pretty sure that I've seen something like this, but can't find it anywhere: Example: # columns Defs # name:string # user_id:integer # etc. class Post < ActiveRecord::Base end I could as well write something...
Ruby on Rails has many different generators and other such things. In my experience, the naming is hardly ever obvious though for if you should use a singular or plural name. For instance for the Controller generator you are suppose to use plural $ rails generate controller Users new But for Models you are suppose to use singular(for...
Can anyone tell me of any open source, preferably PHP/MySQL, document management systems that are similar to: MSDN Library: http://msdn.microsoft.com/en-us/library/ms123401.aspx or Confluence: http://confluence.atlassian.com/display/DOC/Confluence+Documentation+Home ...
Hi, Many databases has a information_schema database, since it is a standard. I want to know where can i find the documentation of it. Such as meaning of columns etc. Thanks. ...
I am using Sandcastle with the Sandcastle Help File Builder on a very large project. This works really fine, but I wanted to upload the generated documentation to my project page, and the documentation generated by Sandcastle contains ASP.NET code while I only own a Linux-based webserver. Is it possible to generate pure HTML documentati...
I use VS2008 (with Document Explorer-based documentation, y'know... before it started sucking with VS2010) and ASP.NET WebForm's documentation is all there. I don't need internet access to get documentation on a given built-in Control or general 'how to' documentation. But I can't see any downloadable Document Explorer content set for A...
Joshua Bloch in his Effective Java writes : "Use the Javadoc @throws tag to document each unchecked exception that a method can throw, but do not use the throws keyword to include unchecked exceptions in the method declaration. " Well that sounds reasonable indeed, but how to find out, what unchecked exception can my method throw? Let...
For example, c++ have cplusplus.com/reference which contain all of c++ standard library complete with definitions and more importantly examples, so I was wondering if there is such a website for python. I know that python is self documented, like i could use help(object) object.__doc__ dir(object) I know of doc.python.org/library w...
How are you generate documentation for javascript ? Especially in a rails application ? Any plugins to rdoc or something similar ? ...
A client of ours is looking at using a tool called Client Access Web. As you can see, there's not a lot of information on the website and before I spin my wheels contacting them I wondered if anyone here had integrated this with a backend application. If you have used CAW, is there any API documentation available for it? ...
Hello folks: My work consists of technical analysis. I like software development, but that is not my job. However, I've developed a substantial system of executables, libraries, databases, and modules. It is not unrealistic to say that such products have made everyone's job easier. I produced a fair amount of documentation for every pro...
What is the best open source document control app for PHP/MySQL? Focus is to be on a system that is robust, easy to use and fast to implement. Needs to have security layers so that files can be public or private. Group assets would be nice. Project management features would be a bonus if they were scalable, robust but not overcomplicate...
Say I have this line: Foo = reader.ReadElementContentAsInt(); I want to rightclick "ReadElementContentAsInt" and select some kind of "Jump to MSDN" option that opens the documentation in my browser. If it's easily extensible to work with other lib docs (e.g. Qt), even better. Do I need a VS plugin? ...
Hi, Is it just me or is the documentation on this project really scarce? I'm trying to find how to use the FtpCreateRemoteDirectory and FTP functionality in general, but can't seem to find anything. Googling FtpCreateRemoteDirectory, only shows the project's source code... ...
Hi there, I am a C/C++ programmer, and I am currently playing with some Javascript code, and I am having problems finding where the documentation is for the standard Javascript libraries that are available in the browser. Specifically, I am setting an onload callback function on a HTMLImageElement, created with new Image(). I also want...
How to have the function calls documented in php ? I would like to have something like : = = = = *function_name1(list of args)* description of the function foo bar (extracted from php-doc like comments) calls: function_name2(list of args) function_name3(list of args) is called in function4 function5 = = = = = = = = = = = =...
At work we keep a general wiki on the intranet for general stuff, but some of our sites are very complex and non-standard with our framework, so I decided to start writing documentation for those non-standard sites. I think it would be a good idea storing the documentation in comments in the conf file that contains all the configuration...
What resources are out there (free or paid) that help walk you through the process of migrating a Ruby on Rails 2 application to Rails 3? I've seen some blog posts (some of which seem out of date) and an eBook for sale somewhere on the RoR website, but what can you recommend as an accurate and complete explanation of what changed from ve...
I'm working on filling in an Rd file for a function. When I use \eqn{2^{x}} in the Details section, then build and install the package, there is no superscripted exponent. Looking at R-exts.pdf, it points to Poisson.Rd as an example on how to use \eqn or \deqn. In the example in that file, there is a superscripted exponent. When I loo...