For example, NSString documentation has – initWithFormat: – initWithFormat:arguments: – initWithFormat:locale: – initWithFormat:locale:arguments: – initWithData:encoding: + stringWithFormat: + localizedStringWithFormat: + stringWithCharacters:length: + stringWithString: + stringWithCString:encoding: + stringWithUTF8String: So what doe...
How can I keep help strings in functions to be visible after applying a decorator? Right now the doc string is (partially) replaced with that of the inner function of the decorator. def deco(fn): def x(*args, **kwargs): return fn(*args, **kwargs) x.func_doc = fn.func_doc x.func_name = fn.func_name return x @dec...
At my company we are currently re-assessing which team will take on the responsibility of external documentation (end user, training and support documentation). We don't have a dedicated technical writer on staff and, like most development teams, our developers struggle with writing high quality, consistent end user docs. Who should ow...
I am looking for the “Software Project Management Templates” such as the following: In our organization we don’t have these, yet. Issue Log Risk Register Change Log In our organization we don’t have these, yet. Where I could get these templates as well as other standard “Software Project Management Templates”? ...
I have objects with many variables that I declare and explain in the comments. I am commenting very thoroughly for later processing using phpDoc, however I have no experience with actually compiling the documentation yet. I find it very annoying that with phpDoc notation, each variable eats up four to six lines of code even if the only ...
In my company we use IBM Doors (formerly Telelogic Doors) for requirement management. We're starting now the development of a new series of applications and we were wondering if Doors would be suitable to accommodate our design documents that were previously made with simple doc files. Basically such document hold text and some diagram...
I'm trying to find the documentation for all of the functions available for the CUDA kernels. The CUDA Reference manual seem to include only the host functions and the CUDA programming guide only includes some details such as the accuracy of these functions but not their documentation. Am I missing something or does this piece of docu...
Hi... I'm here again with a docs question. At my university, when using Eclipse, when placing the cursor over a Java API method name (for example: .size() ), I get very nice documentation about it. Here at home I get Note: This element neither has attached source nor attached Javadoc and hence no information could be found. Any qu...
hi guys, I found oracle documentation a really good resource to learn oracle. But I'm scared of it's lengthy documentation. Now my question is: Should an oracle database user read all oracle documentation? If not, who will read all that? Great thanks. ...
I'm looking for a good tool to document SSIS workflows. Best would be if its not only text based documentation, some visual overview of what happens in the SSIS package would be nice. ...
hi, we are using the java 6 scripting engine in our product, and now we are thinking on adding some debugging abilities. my question is: is it possible? does the java 6 scripting engine has the same capabilities like rhino as far as debugging. some documentation about how to start doing it, some code samples any information would be...
I am trying to extract the packagenames and classnames AND documentation and notes stored in my Ecore-files for including them in external documents (Wiki, Word, etc.) Are there any easy to use tools for doing this or will I have to write my own XSLT-transformation or setup an oAW-project to do this? If there are no end-user friendly t...
Does anyone know of a perlstyle-like guideline for how to document Perl code? Like this bit from javadoc guidelines: "Gets the label of this button. (preferred)" vs. "This method gets the label of this button. (avoid) " (from http://java.sun.com/j2se/javadoc/writingdoccomments/). I haven't found anything at perlstyle...
Hi, I'm writing this Rational number class for one of my cs courses, using C++. We're also asked to hand in a "user documentation", which is sth that i've never done before. What is an example of user documentation? what is the format of it? Thanks! ...
Are there any free tools available for generating ERDs from an existing MySQL database? I've been given the requirement to generate such documentation for a legacy database and would prefer to not have to do it by hand. ...
This may seem like a kind of amorphous question, but how can you get the most of the Linux Kernel Documentation directory? I noticed on the Linux Cross Reference that there is a DocBook directory. How do I build it, use it and is it at all useful? What other ways are there to make efficient use of this directory? ...
I'm working on an open-source project called python-graph. We've come to the point where our APIs are stabilising and we've realised that we need some user docs. We already have automatically generated Epydoc API reference documents, however I want to I want to create something more useful for beginner programmers who find the auto-gener...
Having become used to having auto-generated API docs for most of the languages I use it seems that there's a giant hole where Javascript documentation should be. I can't find any simple Javascript documentation thats arranged by object/module that lists Class and Instance methods in a 'standard' way. A few questions: Am I missing somet...
I have a Java multi-module maven project that I want to build a mvn site and javadocs and have CruiseControl publish the latest daily builds to a configured static location. The trouble is the CruiseControl artifactPublisher allows you to specify a dest directory but it is timestamped with the latest time of the last build. I want to be...
How do you keep track of the business rules in your application code? Lets say we are designing an order entry system. One of the business rules might be: If the stock level of an item drops below its reorder point, create a purchase order for that item to bring its stock level back up to the minimum. So, in our code, we might ha...