Top "Documentation" questions

PHPDoc documentation generator in or out of Eclipse?

I am developing with Eclipse + PDT. I've been adding phpdoc comments into my code, but actually never generated a resulting …

php eclipse documentation phpdoc

Should I use @return self, this or the current class?

I have a method that return the current object, how do I document this? /** * set something * * @return this */ public function …

php documentation phpdoc doc

Using the word "you" in an user manual

I am writing a user manual and I have come to a discussion with a colleague. He says I cannot …

documentation manuals reference-manual

code documentation for python

What is out there on conventions and tools for documenting python source code?

python documentation documentation-generation

Are there some good and modern alternatives to Javadoc?

Let's face it: You don't need to be a designer to see that default Javadoc looks ugly. There are some …

java documentation javadoc

How should unit tests be documented?

I'm trying to improve the number and quality of tests in my Python projects. One of the the difficulties I've …

python unit-testing documentation docstring

What is the equivalent of a Python docstring in Ruby?

In Python, you can access an object's docstring by using obj.__doc__. What is the equivalent action in Ruby?

python ruby-on-rails ruby documentation language-comparisons

How do I link between markdown documents in doxygen?

I have a project with a set of markdown pages that are interlinked with links such as [Go to this …

documentation markdown doxygen

Is there a list of known web crawlers?

I'm trying to get accurate download numbers for some files on a web server. I look at the user agents …

list documentation web-crawler bots

Why are methods in Ruby documentation preceded by a hash sign?

When I see any Ruby method printed in text, it usually appears as: Class#method or #method Now, I would …

ruby documentation