developer documentation (Feature #1951)

Added by Vincent Rabaud almost 13 years ago. Updated over 11 years ago.

Status:Done Start date:2012-05-16
Priority:Normal Due date:
Assignee:- % Done:

0%
Category:documentation
Target version:2.4.6
Difficulty: Pull request:

Description

It would be nice to have some OpenCV developer pdf (just like we have one for users).
That could include:
- coding guidelines (as specified here: http://opencv.willowgarage.com/wiki/CodingStyleGuide) and maybe some astyle options
- general guidelines (submitting patches, using the git fork ....)
- description of some internals in the public API (like InputArray)
- details on how to port C++ code the other languages (Python, Android ...)
- some non-public internals (not sure of what would be useful here).

History

#1
Updated by Andrey Kamaev almost 13 years ago

  • Category set to documentation

#2
Updated by Kirill Kornyakov almost 13 years ago

This is a general question. On the Willow wiki we have a lot of stuff, and something should go to the dedicated opencv.org, something to the code.opencv.org, and something to the docs.opencv.org. We should discuss the distribution of old pages. For developer documentation I see 3 possible places:
  1. Redmine wiki
  2. New section at docs.opencv.org (set of rst-files in repo)
  3. A separate resource, like for example http://docs.python.org/devguide/

I personally like the second option, because it would simplify things a lot (we keep all the documentation in one place, and pdf will be generated in the same way as API ref and user guide), and hopefully motivate users to become co-developers. Redmine wiki could contain only tracker-related stuff: ticket lifecycle, reporter etiquette, release plans may be.

#3
Updated by Vincent Rabaud almost 13 years ago

+1 for having a developer manual; that would make it more coherent with the infrastructure indeed. I see the wiki more useful for archiving (meetings) or things with short life cycles (bugs)

#5
Updated by Vsevolod Glumov over 12 years ago

Vincent, would you mind, if I use your page for the separate dev section in .rst docs together with other sources?

This kind of guide will be better off as a part of .rst docs, than a wiki page.

#6
Updated by Vsevolod Glumov over 12 years ago

  • Assignee set to Vsevolod Glumov

#7
Updated by Kirill Kornyakov over 11 years ago

Vadim has significantly updated the following wiki pages:

I think we can close the ticket, and create new ones, for remaining particular issues...

  • Assignee deleted (Vsevolod Glumov)
  • Status changed from Open to Done
  • Target version set to 2.4.6

Also available in: Atom PDF