Generate standalone JavaDoc reference for Java API (Feature #1847)

Added by Andrey Pavlenko almost 13 years ago. Updated over 12 years ago.

Status:Done Start date:2012-04-28
Priority:Normal Due date:
Assignee:Andrey Kamaev % Done:

100%
Category:android
Target version:2.4.0
Difficulty: Pull request:

Description

It can be either included into the Android binary package or placed on web under 'opencv.itseez.com'.
See details on this web page

Issue hierarchy

Feature #1847: Generate standalone JavaDoc reference for Java APIDoneAndrey Kamaev

Feature #1861: Improve Javadoc documentationDoneAlexander Smorkalov

Associated revisions

Revision c33cb94d
Added by Andrey Pavlenko over 11 years ago

Merge pull request #1847 from ilya-lavrenov:ocl_imgproc_fix

History

#1
Updated by Kirill Kornyakov almost 13 years ago

Here is an example command which allows you to generate javadoc. Download the binary package, go to the OpenCV-2.4 folder and run:

javadoc -sourcepath src -d javadoc -subpackages org.opencv -header "OpenCV 2.4" -nodeprecated -footer "<a href="http://docs.opencv.org">Official OpenCV 2.4 Documentation</a>"

  1. replace opencv.itseez.com links to docs.opencv.org
  2. <em></em> instead of "" for mathematics
  3. <br> or <p> instead of blank lines
  4. <cоde></cоde> instead of ""
  5. leave multiline code segments but with //C++ comments
         * <pre>
     * {@code
     * //C++
     * for(int y = roi.y; y < roi.y + rect.height; y++)
     *   for(int x = roi.x; x < roi.x + rect.width; x++)
     *   {
     *       // ...
     *   }
     * }
     * </pre>
  6. <ul><li><li></ul> instead of * for bullet lists
Links

#2
Updated by Andrey Kamaev almost 13 years ago

1-4 done
5 - moved to future version (#1861)
6 - mostly done

  • Status changed from Open to Done
  • Assignee changed from Andrey Pavlenko to Andrey Kamaev

#3
Updated by Alexander Smorkalov over 12 years ago

  • % Done changed from 0 to 100

Also available in: Atom PDF