oF documentation

Hey all

I generally find that it’s impossible to get to the openFrameworks documentation in google.
Is there a reason for this?

no meta / unsupported pages / fighting the system man?

anyway. it’d be useful if there were quicker ways of accessing documentation in general (and ideally ways of it being built dynamically from the source to avoid errors/ enforce consistent documentation. but that could make the source messy).

Perhaps a PDF cheat sheet or similar.

whaddayathink?

elliot

sounds good, and would be very welcome (especially some good offline resources). maybe something autogenerated? some doxgen magic? see e.g. here http://www.openfoam.com/docs/cpp/ or at least some (semi)official guidelines on code commenting?

Hey folks, this isn’t exactly what you are asking for, but as a stopgap, you can get the docs on your local box with the following wget statement:

  
  
wget --mirror --html-extension --convert-links --restrict-file-names=windows [http://www.openframeworks.cc/documentation](http://www.openframeworks.cc/documentation) -A documentation*,css,js,jpg,gif  
  

awesome trick, thanks! :stuck_out_tongue:

The current documentation is great to start with Openframeworks. But I believe that advanced users need some real documentation (like some Doxygen generated one) to really understand the foundation of this awesome framework not only the basic functions.

I’m a self-made developper, and I discovered Doxygen on Mac, it can’t be easier. You just have to write your documentation within your code with the javadoc syntax.
OK, if you don’t do this as the same time you code, it can be difficult and boring to write it.

I must agree the documentation online seems limited. It is difficult to figure out what is current and what is old tutorial/info/documentation. I’d love to dive in to working with oF but can’t quite figure out what parts of oF web presence are no longer being developed. The forums and code development seem active its just the explanation documentation that seems scattered.

If there is some way for people to help I’d be game.

I completely agree. Though I read somewhere else on the forum that doxygen like documentation isn’t wanted in the source because it makes the source bloated. I do understand that perspective as well however I too find it very time consuming to find out what does what exactly from reading the source code. Especially with addons. I vote for some doxygen like documentation. Willing to help as well. If people want a source without the documentation I think we could come up with some parsing code/script to remove the documentation from the source.

Rg,

Arnaud

I would also welcome more documentation in the source. Doxygen would be ideal, then the web documentation could be kept up-to-date at least semi-automatically.

I am not too familiar with doxygen. But you can tweak the output quite heavily. http://www.stack.nl/~dimitri/doxygen/customize.html

Because doxygen generated output is the best in IMO if you already know your way around in c++. When you’re a beginner it is quite hard as I can still remember :slight_smile:

Having an automated documentation absolutely makes sense (I’d even call it a must have…) But I wouldn’t just drop the existing one that is really beginners friendly.

What about having only the doxygen documentation online, downloadable as a self contained zip file. With a custom landing page that feels like the current documentation. So on main you’d have the most important classes and commands and if you want some in depth information you just click on the classes link and get the doxygen content. That way we could “filter” what functions are presented at first sight but the full documentation is in the same package.

I did a quick test with doxygen here: http://www.undef.ch/uploads/ofDoc/html/

The doc is manually written with this file: http://www.undef.ch/uploads/ofDoc/ofHelp.h

Nice! I agree that this is a step in the right direction.