Automatic documentation of code samples (Feature #2291)
| Status: | Open | Start date: | 2012-08-21 |
|---|---|---|---|
| Priority: | Low | Due date: | |
| Assignee: |  Maksim Shabunin |
% Done: | 0% |
| Category: | documentation | ||
| Target version: | 3.1 | ||
| Difficulty: | Pull request: |
Description
We now have an increasing number of code samples under .../samples in C, C++ and Python
We need to- come up with a standard information header or "help" out put that can be put into each past sample and all future samples that tells
- what that sample does
- how to call that sample
- write a python script that can extract the headers and turn it into a documentation page that users can search through to find out what is in each samples directory
Associated revisions
Merge pull request #2291 from xgvargas:extra-note-for-waitKey
History
Updated by Andrey Kamaev over 12 years ago
- Target version changed from 2.4.3 to 3.0
Updated by Maksim Shabunin almost 10 years ago
- Priority changed from Normal to Low
- Assignee changed from Vadim Pisarevsky to Maksim Shabunin
- Target version changed from 3.0 to 3.1
Updated by Maksim Shabunin over 9 years ago
Issue has been transferred to GitHub: https://github.com/Itseez/opencv/issues/4412