Ask Your Question
1

How to add documentation to a class?

asked 2012-07-15 01:25:59 -0500

aod314 gravatar image

updated 2012-07-16 02:33:33 -0500

Kirill Kornyakov gravatar image

In OpenCV classes exist without documentations. How can I add it?

edit retag flag offensive close merge delete

2 answers

Sort by ยป oldest newest most voted
1

answered 2012-07-16 06:53:08 -0500

Andrey Pavlenko gravatar image

Most of the OpenCV docs (except Java API) are written in RST format (see link1 or link2 for details) and are stored under opencv/modules/<module-name>/doc folder (e.g. for core).

If you'd like to submit some missing docs or a fix to existing one, you can do it via an issue in OpenCV tracker with a patch in RST format or just a plain text suggestion.

edit flag offensive delete link more
1

answered 2012-07-15 05:31:22 -0500

Abid Rahman K gravatar image

updated 2012-07-15 05:31:55 -0500

You can contact the OpenCV developers here : http://code.opencv.org

You can file bugs, bugfixes, features etc there.

If you can write documentation, create patches and apply in that site. Or also you file a bug saying documentation for that class is missing. They will take care of it in the next release.

Eg : http://code.opencv.org/issues/2023#change-5959

edit flag offensive delete link more
Login/Signup to Answer

Question Tools

Stats

Asked: 2012-07-15 01:25:59 -0500

Seen: 115 times

Last updated: Jul 16 '12