-2
votes
1answer
168 views

PDF to doxygen - how to do it? [closed]

I have a big pdf with the documentation for a project and I need to render this to doxygen (so take each function from the pdf and write it out into doxygen). Any suggestions on how to do this ...
7
votes
1answer
396 views

Creating an effective C++ library website and documentation

Creating a C++ library also means documenting it so that others can use it, and that documentation can vary dramatically in quality. How should a website for a C++ library be structured so that it ...
2
votes
1answer
111 views

Ported Functions Licensing

I have found several functions in python 2.7.2 to be very useful and I recreated them in C++ for my own uses. How do I properly give python credit for them? Do I even have to? I never actually looked ...
2
votes
1answer
162 views

Can anyone recommend a toolchain-agnostic way of declaring and documenting inter-package build dependencies?

I currently have a project at my hand that I'll leave soon (PhD work) and should be left in an understandable form since it is likely to be taken up, though it is not known yet by whom and when. ...
1
vote
3answers
147 views

Documentation: What is “appropriate” when expressing a valid range for a parameter?

What is the appropriate method to describe a valid range of a parameter in the documentation of code? Obviously long-form documentation (white papers, API documents, etc) can be more verbose than the ...
1
vote
4answers
265 views

Use the terms “vector” or “array” in high level discussion of C++ code

When I write high-level documentation about what an algorithm does, I use the term "array" to refer to the data structure on which the algorithm operates even though the actual data structure is an ...
10
votes
5answers
274 views

Code documentation: Public vs. Non-Public?

I'm one of those developers that has the mindset that the code written should be self-explanatory and read like a book. HOWEVER, when developing library code for other people to use I try to put as ...
9
votes
9answers
446 views

Studies on code documentation productivity gains/losses

After much searching, I have failed to answer a basic question pertaining to an assumed known in the software development world: WHAT IS KNOWN: Enforcing a strict policy on adequate code ...
2
votes
3answers
410 views

Help finding good documentation for C/C++? [closed]

I have programmed in Java, PHP, C# and a little bit in C in an OS course I have taken recently in college. For all of these languages, I've found decent documentation except C. I couldn't find a good ...