I'm diving into Ruby on Rails and I'm trying to get a grasp on the available docs for the API. I'm trying to find out what the list of "options" are for the redirect_to method in the ActionView API. In the RoR API docs, it says... redirect_to(options = {}, response_status = {}) but it doesn't list what the available options are. ...
I'm reading the documentation about _beginthreadex and _endthreadex but there are a few things I don't understand. Note that the documentation keeps documenting the "extended" and normal functions at the same time, but I'm not using _beginthread and _endthread; only their extended versions. You can call _endthread or _endthreade...
We are in the final preparations for releasing a product and we have to touch up the user guide. The current one we have is an amalgamation of some MS Word and some OpenOffice.org documents. While it's sufficient, we going to massively re-do it after the release in readiness for the following release. We haven't really been happy with ...
So I'm trying to document the format of the json returned by an api I am writing against and I'd like to know if there is any popular format for the documentation of json structure. Note I'm not trying to to test or validate anything, I'm just using this for documentation. Also some ways to add comments to non-constants(items always re...
According to the documentation: Fills the internal buffer with the specified number of bytes read from the stream. What does this mean (what's the internal buffer?)? ...
Does anyone have any piece of software that actually does a good job of help? I've seen some good ideas out there but by and large help files do not do "what it says on the tin" i.e. They just aren't "helpful." Lets face it, help files are so 80s, does anyone read them? As software developers we know people don't read them, so we don't ...
I have Python classes with object attributes which are only declared as part of running the constructor, like so: class Foo(object): def __init__(self, base): self.basepath = base temp = [] for run in os.listdir(self.basepath): if self.foo(run): temp.append(run) self.avail...
Hi, I am working on product which is essentially procedural (C) code in OOPs body (C++) resulting in hard to understand architecture. As I dig through the code, I want to document my understanding in simplified notation. To give an example I would like to document a given function in following format Function Library Module Compon...
Netbeans currently has intellisense, but I want documentation on methods and what they do. Is this possible on Netbeans? Maybe when pressing F1, have the doc window open. Thanks! ...
How can Doxygen be used to create user manuals? The website says it can be done, but I am not sure how. Are there any markup examples for this situation? ...
What documentation (books or online resources) you would recommend for a JPA newbie, which want to program with the play framework? In play you only use annotations and hibernate as JPA implementation, so it would be useful if there would be the focus on. I started with wiki-book, but not sure if it is the best solution. A book for gr...
Possible Duplicate: How to search for punctuation that gets ignored by Google? Occasionally, I come across an unfamiliar operator that can't be read aloud. One example is the heredoc notation of PHP, where strings are demarked with <<<. Another example is |= in C#. (If I'm entirely honest, I still don't know 100% what it is ...
How can I document an overridden method or an implemented virtual method of a sub class? Should I use @copydoc? class A { /** * A detailed description........ */ virtual int foo(int i); } class B : public A { /** {I won't write the same description again.} */ int foo(int i); } ...
In the documentation for Clojure special forms (http://clojure.org/special_forms) the example for :pre and :post looks like this: (defn constrained-sqr [x] {:pre [(pos? x)] :post [(> % 16), (< % 225)]} (* x x)) How can Clojure tell if the map containing the meta-data is not the definition of the function? Shouldn't the m...
Details on the packages/types is in the Scala API documentation on scala-lang.org. But that's organised by class and I (as a Scala neophyte) find it difficult to locate the exact data type I need and work out what operation are supported on what (especially in the huge and powerful scala.collections.* tree). Is there an online or dead-t...
Hello, Can anybody suggest a good tool to document the format of an XML document? I'm not looking for DTD or something that validates XML; I'm looking for something that helps me generate documentation that describes in plain language what each node/attribute/value is for. ...
Many of Excel's built-in functions can take array arguments. Sometimes the result is documented in the help and sometimes not. So: =IF({1,0,1}, 42, 99) will return {42, 99, 42}. The help for 'IF' covers array arguments. But: =INDEX({2,3,5,7,11}, {2,4}) will return {3, 7}. This is intuitive, but I can't find a Microsoft source that ...
Possible Duplicate: Best reference sites for HTML and JavaScript programming What is the best online javascript/css/html/xhtml/dom reference? A good Javascript API reference documentation related to browsers and DOM Where can I find a good Javascript/DOM reference? I know the MSDN one: http://msdn.microsoft.com/en-us/librar...
Hey, I've installed Flash Moto CMS, and I want to link it with any kind of TemplateMonster but I have no idea on how I can do this right now. So I'm asking you for help ! Any documentation, any video tutorials !!! Thanks ...
In the FRC documentation, it says that it is intended to efficiently manage the results returned from a Core Data fetch request to provide data for a UITableView object. I am trying to setup my Core Data stack to handle the storage and retrieval of some VERY basic data. Can I not use FRC? I need to display a value set in the db to a UIL...