I'm new to PHP, and my current job requires me to pick up the language at an extremely quick pace. I'm a documentation stickler. I even like to write documentation. I'm familiar with accepted documentation syntax and tools for a handful of languages. This is not the case for PHP. I know there are always multiple methods for writing do...
What do you think is the advantage of processes like CMMI in a project. When I go into a CMMI meeting I feel like I wasted a couple of hours because I don't see any value in filling all those project related documents that I know will never be reviewed again by anyone. I have updated hundreds of CMMI related documents in the last 2 years...
I am sure they use something really fancy to create their documentations and guides. Everything is so streamlined and equal, and they always have a HTML and a PDF version. Now we make a big framework and want to provide a good documentation that's set up the way Apple does it. Online in HTML format and offline in PDF. Any idea how the A...
We need something pretty exactly the same as Apple has got. When we write a documentation or guide for our framework users, we want to write all the text just once, but then drop it out to the web server as HTML version and at the same time also create a PDF out of it for the users who wish to download it as PDF. Maybe there are good so...
When I work on C# projects, I can use Microsoft's SandCastle application to generate nice, easy to read and use documentation for my entire code base. I'm curious: Does such an automagic documentation method exist for native C++ applications? ...
Hi, I'm using Sandcastle Help File Builder to build the documentation for an open source project, and I'm facing two issues : The documentation content is in French. I set the language to French in the SHFB project, but most of the generated text is still in English ("Properties", "Inheritance Hierarchy", "See also"...). I saw that th...
I did some searching on the site for an answer to help guide me, but my efforts netted 0 results. I need to write a system design document for a client that is bringing their entire operation in house. At the current moment they have outsourced all of their programming to offshore developers, and I fear that many of the issues with o...
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints, interested in tools to help me automate t...
Hello, I use code-generation for my data access layer and Doxygen for documentation. My problem is that I can't add Xml comments on the generated classes since they will be overwritten as soon as I re-generate the code. To be more precise I can add Xml comments to my custom methods (which are in a separate file as partial classes) but I...
I am getting different results based on whether I precompile a regular expression: >>> re.compile('mr', re.IGNORECASE).sub('', 'Mr Bean') ' Bean' >>> re.sub('mr', '', 'Mr Bean', re.IGNORECASE) 'Mr Bean' The Python documentation says Some of the functions are simplified versions of the full featured methods for compiled regular express...
Is there a Java SE 6 documentation that is searchable like Apple's built-in Xcode documentation? I suppose Google could be used to search the website that the Java 6 documentation is hosted on but I'd prefer a nice app or website where I can just search for the things I want. Or I could even just CTRL-F to find it on the page... ...
In addition to my Previous topic on How to use SVN, Branch? Tag? Trunk? I would like to get in-depth on how a programmer should/could use TFS. The things that are most interesting to me is not how to set up the server, rather how you use it on a daily basis. In the area of software engineering where your responsibility not only l...
There seem to be a ton of UI properties that can be set with UIManager.put("key", value); Is there a list somewhere of all keys that can be set? ...
I'm pretty green at all the new features implemented with the PHP SPL, from this very long list all I've played with was with the RecursiveDirectoryIterator class, I don't even fully understand it I just saw an example and hacked my way through it. I've come to love the PHP documentation, but the lack of documentation on these new and s...
I'm trying to convince the team I'm working for (which consists mostly of semi-technical or non-technical people) to drop our Windows-shared-folder stored word document based method of working on shared documents (product documentation, requirement documents, design documents, marketing material etc.) in favor of some web based Wiki like...
I have inherited a large-ish application written in C++ on Linux. Is there an easy way to get a report of each class and the public methods exposed in each class? I've looked at Doxygen, but that appears to just provide easy browsing of the codebase, not tailored for providing anything that can be exported to Excel, etc. ...
I have installed PyQt GPL v4.6.2 for Python v3.1 and Qt by Nokia v4.6.0 (OpenSource), but the documentation in PyQt is not coming up. Example docs are all blank too. Would anyone mind writing a step-by-step guide on what links to visit and what procedures must be executed in order to get text to come up for the PyQt Documentation? Edit...
Greetings Is there any free software that can take C source files and generating documentation using them? Thanks ...
Background I come from a hardware development engineering background. Our detailed specifications contained a revision history as a table at the end or beginning of the—typically MS Word—document. These specs were saved in a document management system separate from the management system used to store the hardware design deliverables, su...
Hi, I'm going to design a RESTful API soon, thus I need to describe it in order to enable other people to start implementing clients using it. I've looked around a bit, but unfortunately, I've not found any standardized form of describing web-based RESTful services. What I'am looking for is something like JavaDoc, although it don't ha...