I'm write PHP applications to distribute publicly, and am trying to ensure they run correctly on all popular web server software (IIS, Apache, NGINX, Lighttpd). Does anybody know if someone has created definitive matrix of $_SERVER array items for each different popular server software package? Sounds like a good idea, and I just want ...
Hey all, I suppose this is more of an opinion than right / wrong. But I was wondering how you develop - I personally have tried coding before testing as well as test-driven development, and realized how much nicer test-driven development is, if you can hold your horses. But what I'm wondering is how do you develop? Also where does doc...
Hey guys, I am programming in objc and am documenting my stuff with doxygen. Unfortunately it is not documenting my c functions only my classes and their methods. I have them defined in a .h like so: /// Returns whether the current machine is little endian based. BOOL littleEndian(void); and then I have them implemented in a .m. Does ...
Say I have this constructor: /// <summary> /// Example comment. /// </summary> public SftpConnection(string host, string username, string password, int port) {...} which has these overloads: public SftpConnection(string host, string username, string password) : this(host, username, password, 22) { } public SftpConnection(s...
Is there a document editor that helps formatting documents like API documents or specifications? I prefer not to use Word but something that is more productive. ...
We have developed an application in c# .net and aim to make it deployable within our intranet. We would like to have a solid documentation to go along with it but are unsure of the best platform to document this. Any tools available to facilitate this process? I found out about Doxygen, Htmlhelp or Dr Explain but i'm still not convinced...
In my PHP years http://www.php.net was my best friend. I think that the clean and complete API reference on that website is one of the best features of the language. It references every function available with examples and comments from the community. I want to ask all the Scala programmers out there: Is there something like this f...
I've been told that Scaladocs is the best source for Scala API documentation: http://www.scala-lang.org/api/current/index.html I've found an example using scala.io.Source.fromURL(url).getLines The example works, but fromURL is not in that site. Where can I find a more exhaustive documentation on the methods available? ...
I use a lot of illustrations, diagrams and equations to document C++ and python codes, and a way to do this is to inline them with doxygen. The problem is that, when coding, they are not directly available in the code (unless I use ascii-art for this purpose). Is there an automatic, quick and fast way to, while coding, view the generate...
According to PhpDocumntor each block of comment in order to be converted into a valid piece of documentation requires to be encapsulated like this: /** * This function is used blah, blah, blah * line 2 * line 2 * ... */ function MyFunc($string) {... Do you know if it's possible (maybe by changing some settings) to avoid being forced t...
I'm using the RESTful service starter kit and was having trouble adding documentation to the built in Service help page. I'm able to add documentation to each method in the Description using the WebHelp attribute. What I need and want to add documentation to the Request Schema that is generated for each method through the Request Schema...
Can someone suggest me tools/templates and example to draw diagrams for showing information flow in highly event-driven distributed large scale information system. The system consists of heterogenous devices like PC,data-centers,mobile hand-helds, monitoring sensors (like cameras, laser scanners) used by different users and each user gen...
The Delphi XE dbExpress tutorial in the online documentation uses ApplyUpdates(-1): // Client data set has provider do update. ClientDataSet1.ApplyUpdates(-1); Some online sources however say it would have advantages to use ApplyUpdates(0), and it would be a widespread mistake or bad practice to use -1. Is this true? And when and ...
Any pattern&practise here for documentation in Haskell? Are there anything as elegant/handy as what Python does below? >>> help([].count) Help on built-in function count: count(...) L.count(value) -> integer -- return number of occurrences of value ...
I am not really a UML-User and relatively new to OO-Programming, i just used UML if i had to and it is long ago. Now i had to write an iPhone-Software and dont really know, how to realize Messages and Protocolls in an UML-Diagramm. And.. did i understand it in the right way, that in Objective-C is just one kind of inheritance ? You can...
Hey Folks, i have to document a staging area. But i have problems by document the realtion between the diffrent databases. i want to do something like that Table 1(DB 1) Table 2(DB 2) Column 1 ETL logic-> Coulmn 1 I tried out Visio but i didn't found the right shapes which would fit my needs. Are there exp...
We use an issue tracker to track software issues: bugs, new features, enhancements, etc. Very often, the code change to resolve an issue requires an update to documentation; e.g. user manual, install manual, test procedure, etc. Generally the documentation is done by a different group of people -- tech writers, QA team -- but it is helpf...
It used to be that the ruby on rails guides for version 3.0 were at http://edgeguides.rubyonrails.org/ and the guides for version 2.3 were at http://guides.rubyonrails.org . Now that version 3 has been released, its guides have been moved to the main URL. Is there any way to access the guides for rails 2.3? ...
I'm using doxygen to generate HTML documentation. I have a C++ source file that contains only global functions. All of the global functions are document, and the documentation is properly generated. For all of the headers in the project there is a link to “see the code that this documentation was generated by.” (as a link to the HTMLized...
I'd like to somehow create some kind of class that can read a source code file(ie java) and from that extract the method names, the method source-code, the methods description comment and such. Is this possible in any simple way? I'd also like to avoid complicated parsers and such. Is regexp any good for this? Programming language = ja...