Hi, I had been doing a little bit of facebook app building as a hobby about a year and a half back. I know they keep updating and adding and removing things all the time. I will be travelling for a few days(can't use my laptop), so, I want to use this time to brush-up my skills on fb apps. I'll be print out the material you guys suggest...
I know that PHPDoc exists, but phpdoc wants you to put comments in your PHP files so that it can parse them... What I want is something different: Suppose that I have 10 PHP classes... all I want is a script that can read those classes and automatically generate a representation of those class structures, i.e. what classes are in them, ...
Hi, I'm starting out with android development, and am really confused by the javadoc on intents. For example I'm trying to launch the intent: android.provider.ContactsContract.Intents.ATTACH_IMAGE I try to launch it with: Intent test = new Intent(ContactsContract.Intents.ATTACH_IMAGE); startActivity(test); and it returns an Activ...
When writing up Functional requirements, is it best practice NOT to incorporate the solution definition into the document? Many of the site I work on have a solution already defined - such an open source CMS (WordPress or Drupal). Even though we have the solution, we still have to work out the fine details, for example what fields will b...
Hi All, I was wondering if you know of any utilities for writing software specifications? Ideally a utility that allows one to define features, expectations, and relationships between various system functions. I'm looking for something that can be presented to customers so I'm assuming it would be high level but easily translated int...
I've got a system with multiple nodes which one-way communicate to other nodes. I want to diagram the node system in as simple way as possible; if the node-communication is represented by an arrow from the source node to the target node, that would mean the diagram would be one that contains as few crossing arrows as possible. Assuming...
Hi, In my project settings is turned on the XML Documentation file checkbox. In this case every public method, fiels or enum without XML Declaration is underline with green wave. And I have a warning in the error window. The Question is the next: Does Visual Studio has specific define or region to skip some method or smth else from XM...
I'm in the process of documenting a Ruby project with rdoc, and I discovered the darkfish rdoc formatter. I really like it, but the :call-seq: tag no longer works. Instead, it puts the literal string :call-seq: in the documentation and then formats the call sequence itself as a code block. I don't want to just take all of the :call-se...
I'm looking for a nice way to generate documentation for a REST API. It doesn't need to actually connect with the code or anything, but it'd be awesome to be able to write the documentation as text files, point the tool at it, and generate some docs from it. Anyone out there have any ideas? I know I'm being a bit vague, but, to be hone...
Another co-worker and I have been heavily modifying the PHP Zookeeper extension but the one thing really bothering me is the reliance on PHP error's vs Exceptions. The original source is here: http://github.com/andreiz/php-zookeeper/blob/master/php_zookeeper.c#L209 Instead it would be nicer to throw up a Zookeeper_NodeNotExists or simi...
So I have defined some vars to hold state data in my clojure code. I have just discovered I can add a doc-string to those vars e.g.: (def ^{:doc "Documentation for *my-var*"} *my-var*) That lets me call (doc *my-var*) at the REPL. This seems like a valid and useful thing to do but it doesn't seem like common practice in the (...
I spend a lot of time offline, and while normally I'm in the middle of some book or magazine for work, I've recently been reading through the MSDN Library documentation of Visual Studio 2010 Application Lifecycle Management (aka TFS 2010). Unfortunately, this documentation doesn't seem to be included on either the Vs2010 nor the VsAlm2...
I am looking for a way to create a chm from assemblies and xml doc files that does not need to have anything installed. Requirements xcopy deployable run from the command line with no UI (although the initial config can be done with a UI) Any recommendations? ...
This question is inspired by the following sources: Clean code by Robert C. Martin Agile Principles, Patterns, and Practices in C# by Robert C. Martin and Micah Martin What is software design? by Jack W. Reeves My current project (where we should comment everything in the code) Mr. Reeves states in his paper that the code is the desi...
Hi, Up to now I have programmed for iPhone only, but now there is need to do some work on Mac OS X as well. I noticed there are no Properties specified in documentation's class reference. Of course, you can find them somehow by investigating set methods and mother classes but this makes work quite slow and painful. Is there any refere...
Hello there! I'll have to generate a lot of externs so I can interface with the .NET framework from another programming language for an open-source project I'm working on. I was wondering if there is any way to get all the MSDN class references as an XML or something? I'm thinking about parsing the actual HTML, but it seems it won't be v...
Online webservice API/reference guide - What software application do you use to document your webservice/API technical specification/reference guide? ...
I'm debugging a thorny CL-related problem and need a better understanding of how classloading works in JBoss 5.1. Yes, I read http://community.jboss.org/wiki/JBossClassLoaderIntroduction and http://community.jboss.org/wiki/JBossClassLoaderOverviewandGoals; they are useful to start with, but are not very precise in their description. The...
What is the correct syntax for an XML comment for a class property? ...
I am writing an app which is not simple (good to be ambitious etc...), but need to write documentation like requirements, design stuff, etc. What would be a good tool which provides templates for all of this? Thanks ...