How to obtain the class documentation of redmine

Added by Antoine Rodriguez almost 13 years ago

Hi,

I try to obtain more information of redmine for building my plugin.

The information obtained in the website is quite poor.

However I found that we can have the documentation API by doing a "rake doc" inside the redmine folder.

When I've done that I had an error like this : "Please install RDoc 2.4.2+ to generate documentation." But the rdoc was installed and with an version 3.

I solved this by adding to the Gemfile this : gem "rdoc", ">= 2.4.2"

However no doc is generated inside the doc folder .... How can I have the complete documentation of redmine ?

My redmine is 1.4.1

Best regards,

Replies (3)

RE: How to obtain the class documentation of redmine - Added by Antoine Rodriguez almost 13 years ago

I've tried with redmine 2.0.0 and the command :

rake doc

under the redmine folder produce nothing and do not need any alteration.

However no doc is generated ........

No one know how to generate the doc ?

Best regards,

RE: How to obtain the class documentation of redmine - Added by Mischa The Evil almost 13 years ago

According to source:/trunk/lib/tasks/yardoc.rake you should be able to generate YARD documentation using rake yard. Though, I'm currently not able to test if this works or not.

RE: How to obtain the class documentation of redmine - Added by Antoine Rodriguez almost 13 years ago

Thank you for the answer ! :)

It does not work, I'll up a ticket.

Best regards.

(1-3/3)

Project

General

Profile

Redmine