I am designing a class library designed to solve a wide scope of problems. One thing about this library is that it will be usable by several different languages and environments natively. For example, there will be a C++ version written entirely in C++, a .NET version written in C# and a Java version written in Java, without any dependen...
I have debugging functions that are called in just about every function of a large program. They are conditionally turned on by a defined macro variable. I don't want these showing up in call graphs, since I can be fairly sure that every function has them. Is there a way to exclude the function from the graph /*! Step 3: * @callgrap...
I am a university student and I have been working on the same software project for the past two years. It is not a class project; it is sponsored by an outside organization, and it has been my part time job during the school year and my full time job during the summer. I have to complete everything by the end of the summer, and the fun...
I want to compile the Xml documentation from a large project into some form that's easy to read and search, hopefully more convenient than browsing the raw source code. I'm not particularly worried about the end format - CHM, HTML, xyz - as long as it's usable. Being able to easily roll in (or link to) additional content would be a plus....
I haven't quite figured out a sensible workflow for building packages and writing their documentation. I want as much of the process (and the documentation) as possible to be automatically generated. The obvious way to do this seems to be to use package.skeleton to create the basic package files, then programmatically overwrite the DES...
I am having a strange issue with the developer documentation (which i have only noticed after installing Xcode 3.2.3). My problem is that as you type in the search field (upper right) it looses focus and immediately starts looking for the first few letters you type. For example if you looking for "NSObject" you start typing "NSO" and as ...
Does anyone have a favorite "go-to" paper, web site, etc., for explaining the basics behind Fourier theory / discrete Fourier transforms? I am not overly inclined mathematically, and while I know this particular domain requires some math skills I'm hoping for documentation that eases me into it so I have some understanding of intent by ...
I've read a comment from Norman Ramsey about using metadata for generating documentation in lua. I'm attempting to generate documentation from my lib, and I'd rather not use luadoc if possible. I'd like to know more about this "metadata-oriented" method for generating documentation - methodology, examples, or programs used. Other answ...
I am making web pages to document how people will use some free mapping software my team is releasing soon. I am not a web page designer, and didnt want to spend too much time getting familiar with CSS, but i still want a clean and professional site. So after some web surfing research, I realized Google's documentation sites (MAPS API e...
I can't believe anyone would normally object to documentation and comments, but whats the best practice (and practical) for doing so in PHP? In JavaScript, you can document your code and then run a minimizer to produce a production version of your code for use. What about in PHP, does the extra lines of text affect performance? Should y...
Can you recommend any books about how to write technical documentation? I'm after some guidance on overall layout of the document, style (as in prose, not CSS), when and where to go into detail, etc. Please post only one book per answer ...
As far as I can tell 90% of information that can be found through a google search on compojure/ring is outdated for 0.4.0. Can anyone point me toward some good current documentation? Thanks! ...
I always learned that doing maximum code coverage whit unit tests is good. I also hear developers from big companies such as Microsoft saying that they write more lines of testing code than the executable code itself. Now, is it really great? Doesn't it seem sometimes like a complete loss of time which has an only effect to making maint...
I have used PSPad alot and I would like to make an extension for PSPad, but I don't know how to do it. I cannot find anywhere an API documentation to make the extensions. Can someone please help me? ...
I'm going to need to start putting together some end-user documentation for my software I'm working on. I'm looking for a good HTML/Browser-based help file solution. I am NOT looking for the CHM solution. I'm looking for just a good hierarchical/structured HTML help documentation system that is viewable in the browser. Also, if its sear...
What tools exist for developing platform indepedent API Documentation? I'm in the process of designing a proposed API, and want to write documentation in a structured and easily editable way. A lot of the answers I've seen have basically been "Use built in language specific documentation tools", but since I'm designing the API from a 't...
We're working on a project that requires us to have really easy to use documentation. There is a multitude of posts on Stack Overflow that talk about what makes good documentation, but few about the way it's actually displayed and usability issues. What projects have good examples of typography and design in their documentation? What is...
I'm new to PHP development, and I'm wondering if the community has any guidelines for inline documentation of code using comments. I'd love something like Python's PEP 257, but I'd settle for a format used by a popular document extraction tool, or even the documentation standard of a popular product. ...
Say I'm learning about the UIGestureRecognizer class. In the intro text it mentions UITapGestureRecognizer and UIRotationGestureRecognizer as two concrete implementations. But what other recognizers are there? This is just one example where I'd like to see a list of all the types in the framework that derive from a base class or implemen...
I have gone through the topics Functional Specification, High Level Design, Low Level Design. I read their description & template from different sites. I know the difference between High Level Design & Low Level Design. Both the functional specification & Hign/Low level design provides the guide for coding the programmer, both describes ...