Contribute: Adding documentation to new class at 3.0 [closed]

asked 2015-09-02 08:09:40 -0500

joaofaro gravatar image

updated 2015-09-19 11:58:11 -0500

Hi!

I'm trying to contribute with a new class to the OpenCV 3 but I'm stuck with the documentation. How can I add it? I can't find the .rst files (at 2.4 repo they were at opencv/modules/<module-name>/doc). Should I add my project (with cpp, hpp and rst files) to the 2.4 instead of 3.0?

Maybe I'm just being dumb, but I getting tired of trying to find how I should add the rst files.

Thanks in advance!

edit retag flag offensive reopen merge delete

Closed for the following reason the question is answered, right answer was accepted by sturkmen
close date 2020-11-29 07:16:27.494399

Comments

2

Starting with OpenCV 3.0 documentation changed to Doxygen system. Now the docs are automatically generated by adding special markup text in header files. Please, take a look here

LorenaGdL gravatar imageLorenaGdL ( 2015-09-02 08:20:43 -0500 )edit
2

@joaofaro give github link of your contribution. i can comment on source files what to do.

sturkmen gravatar imagesturkmen ( 2015-09-02 09:28:59 -0500 )edit
1

Thanks for the help!

@sturkmen I have submitted a pull request (https://github.com/Itseez/opencv/pull...). The public funtions are documented in svmsgd.hpp as required (at least I tried to) but I didn't realize where I should add the explanation header and the reference. If you can point the correct location of each section I will complete the documentation as required.

Thanks in advance!

EDIT: The buildbot returned an error in Mac compilation, I will also try to understand why

joaofaro gravatar imagejoaofaro ( 2015-09-02 11:27:17 -0500 )edit
1

just saying, the doc-buildbot hates tabs(with a passion). please replace them with 4 spaces globally ;)

(the mac issue is an infrastructure problem, not your fault or responsibility, it hopefully won't happen again, once you make a new push with whitespace changes)

"I didn't realize where I should add the explanation header and the reference" - https://github.com/Itseez/opencv/pull... put it all here for a start, they will kindly tell you, if and where anything should be moved.

berak gravatar imageberak ( 2015-09-02 11:31:18 -0500 )edit
2

I'd rather make the pull request to the contrib repo directly (it's a whole new class): https://github.com/Itseez/opencv_contrib

LorenaGdL gravatar imageLorenaGdL ( 2015-09-02 11:44:40 -0500 )edit

@berak I read about that but I forgot to convert the tabs before push. Now, it's corrected, I apologize for that. I have also updated the .hpp with some more information.

@LorenaGdL I thought at the beggining but at How to Contribute section it is mentioned the Itseez/opencv repo.

I apologize for all this mess but it's the first time I contribute

joaofaro gravatar imagejoaofaro ( 2015-09-02 12:40:10 -0500 )edit
2

@joaofaro, no need at all to apologize.(that's probably only nessecary, if you (explicitly)step on someone's toes)

you're doing great for the 1st time !

berak gravatar imageberak ( 2015-09-02 13:28:21 -0500 )edit
1

@joaofaro , don't worry, battling the buildbots usually takes a few iterations.

(also, fixing things for one os might break it for another, expect surprises ;)

berak gravatar imageberak ( 2015-09-03 01:00:27 -0500 )edit

Sorry to bother you again but I had an unsuccessfully build at Android (the others succeeded).

error: RPC failed; result=35, HTTP code = 0 (http://pullrequest.opencv.org/buildbo...)

Anyone knows why this is happening?

joaofaro gravatar imagejoaofaro ( 2015-09-06 12:28:53 -0500 )edit
1

a timeout, i guess. internal buildbot problem. not your fault or responsibility.

it will either restart on its own, or when you do your next push

berak gravatar imageberak ( 2015-09-06 12:37:21 -0500 )edit