Peter M. Groen / openbr

Commit d4831be338485f1ad2b4d09d220c508380774086

Authored by Jordan Cheney
1 parent 19591595

Close to using stock mkdocs

Inline Side-by-side
Showing 5 changed files with 200 additions and 188 deletions
docs/docs/api_docs.md 0 → 100644
  View file @d4831be
  1 +# API Documentation
  2 +
  3 +The complete documentation for the API's included in OpenBR.
... ...
docs/docs/api_docs/cpp_api.md
  View file @d4831be
... ... @@ -6,8 +6,8 @@ The C++ Plugin API is a pluggable API designed to allow the succinct expression
6 6  
7 7 The API defines two data structures:
8 8  
9   -* [File](api_docs/cpp_api/file/file.md)s are typically used to store the path to a file on disk with associated metadata (in the form of key-value pairs). In the example above, we store the rectangles detected by [Cascade](api_docs/plugins/metadata.md#cascadetransform) as metadata which are then used by [Draw](api_docs/plugins/gui.md#drawtransform) for visualization.
10   -* [Template](api_docs/cpp_api/template/template.md)s are containers for images and [File](api_docs/cpp_api/file/file.md)s. Images in OpenBR are OpenCV Mats and are member variables of Templates. Templates can contain one or more images.
  9 +* [File](cpp_api/file/file.md)s are typically used to store the path to a file on disk with associated metadata (in the form of key-value pairs). In the example above, we store the rectangles detected by [Cascade](plugins/metadata.md#cascadetransform) as metadata which are then used by [Draw](plugins/gui.md#drawtransform) for visualization.
  10 +* [Template](cpp_api/template/template.md)s are containers for images and [File](cpp_api/file/file.md)s. Images in OpenBR are OpenCV Mats and are member variables of Templates. Templates can contain one or more images.
11 11  
12 12 ## Plugin Abstractions
13 13  
... ... @@ -17,7 +17,7 @@ Plugin | Function
17 17 --- | ---
18 18 [Initializer](cpp_api/initializer/initializer.md) | Initializes shared contexts and variables at the launch of OpenBR. Typically used with third-party plugins.
19 19 [Transform](cpp_api/transform/transform.md) | The most common plugin type in OpenBR. Provides the basis for algorithms by transforming images or metadata.
20   -[Distance](cpp_api/distance/distance.md) | Used to compute a distance metric between [Template](api_docs/cpp_api/template/template.md)s.
  20 +[Distance](cpp_api/distance/distance.md) | Used to compute a distance metric between [Template](cpp_api/template/template.md)s.
21 21 [Format](cpp_api/format/format.md) | Used for I/O. Formats handle file types that correspond to single objects (e.g. .jpg, .png, etc.).
22 22 [Gallery](cpp_api/gallery/gallery.md) | Used for I/O. Galleries handle file types that correspond to many objects (e.g. .csv., .xml, etc.).
23 23 [Output](cpp_api/output/output.md) | Used for I/O. Outputs handle the results of [Distance](cpp_api/distance/distance.md) comparisons.
... ... @@ -38,4 +38,4 @@ Plugin | Function
38 38  
39 39 As previously mentioned, all plugins in OpenBR are constructed using strings stored as [Files](cpp_api/file/file.md). The construction is done at runtime by a [Factory](cpp_api/factory/factory.md) class[^1]. The [Factory](cpp_api/factory/factory.md) expects strings of the form `PluginName(property1=value1,property2=value2...propertyN=valueN)` (value lists are also permitted). It looks up the `PluginName` in a static registry and builds the plugin if found. The registry is populated using a special macro [BR_REGISTER](cpp_api/factory/macros.md#br_register); each plugin needs to register itself and its base abstraction in the factory to enable construction. The purpose of this is to allow algorithms to be described completely by strings. For more information on algorithms in OpenBR please see the [tutorial](../tutorials.md#algorithms-in-openbr)
40 40  
41   -[^1]: [Industrial Strength Pluggable Factories](https://adtmag.com/articles/2000/09/25/industrial-strength-pluggable-factories.aspx)
42 41 \ No newline at end of file
  42 +[^1]: [Industrial Strength Pluggable Factories](https://adtmag.com/articles/2000/09/25/industrial-strength-pluggable-factories.aspx)
... ...
docs/docs/plugin_docs.md 0 → 100644
  View file @d4831be
  1 +# Plugin Documentation
  2 +
  3 +The complete documentation of all of OpenBR's plugins
... ...
docs/mkdocs.yml
  View file @d4831be
... ... @@ -8,7 +8,6 @@ theme_dir: themes/readthedocs/
8 8 links_file: docs/links.md
9 9 contributors_file: docs/contributors.md
10 10  
11   -include_search: True
12 11 include_next_prev: False
13 12  
14 13 markdown_extensions:
... ... @@ -16,185 +15,190 @@ markdown_extensions:
16 15 - footnotes
17 16  
18 17 pages:
19   -- [index.md, Home]
20   -- [install.md, Install]
21   -- [tutorials.md, Tutorials]
22   -- [contribute.md, Contribute]
23   -
24   -# C API
25   -- [api_docs/c_api.md, API Docs, C API]
26   -- [api_docs/c_api/typedefs.md, C API, Typedefs]
27   -- [api_docs/c_api/functions.md, C API, Functions]
28   -- [api_docs/python_api.md, API Docs, Python wrapper API]
29   -- [api_docs/cpp_api.md, API Docs, C++ Plugin API]
30   -
31   -# API Functions
32   -- [api_docs/cpp_api/apifunctions.md, C++ Plugin API, API Functions]
33   -
34   -# File
35   -- [api_docs/cpp_api/file/file.md, C++ Plugin API, File]
36   -- [api_docs/cpp_api/file/members.md, File, Members]
37   -- [api_docs/cpp_api/file/constructors.md, File, Constructors]
38   -- [api_docs/cpp_api/file/statics.md, File, Static Functions]
39   -- [api_docs/cpp_api/file/functions.md, File, Functions]
40   -
41   -# FileList
42   -- [api_docs/cpp_api/filelist/filelist.md, C++ Plugin API, FileList]
43   -- [api_docs/cpp_api/filelist/constructors.md, FileList, Constructors]
44   -- [api_docs/cpp_api/filelist/statics.md, FileList, Static Functions]
45   -- [api_docs/cpp_api/filelist/functions.md, FileList, Functions]
46   -
47   -# Template
48   -- [api_docs/cpp_api/template/template.md, C++ Plugin API, Template]
49   -- [api_docs/cpp_api/template/members.md, Template, Members]
50   -- [api_docs/cpp_api/template/constructors.md, Template, Constructors]
51   -- [api_docs/cpp_api/template/statics.md, Template, Static Functions]
52   -- [api_docs/cpp_api/template/functions.md, Template, Functions]
53   -
54   -# TemplateList
55   -- [api_docs/cpp_api/templatelist/templatelist.md, C++ Plugin API, TemplateList]
56   -- [api_docs/cpp_api/templatelist/constructors.md, TemplateList, Constructors]
57   -- [api_docs/cpp_api/templatelist/statics.md, TemplateList, Static Functions]
58   -- [api_docs/cpp_api/templatelist/functions.md, TemplateList, Functions]
59   -
60   -# Factory
61   -- [api_docs/cpp_api/factory/factory.md, C++ Plugin API, Factory]
62   -- [api_docs/cpp_api/factory/members.md, Factory, Members]
63   -- [api_docs/cpp_api/factory/constructors.md, Factory, Constructors]
64   -- [api_docs/cpp_api/factory/macros.md, Factory, Macros]
65   -- [api_docs/cpp_api/factory/statics.md, Factory, Static Functions]
66   -
67   -# Object
68   -- [api_docs/cpp_api/object/object.md, C++ Plugin API, Object]
69   -- [api_docs/cpp_api/object/members.md, Object, Members]
70   -- [api_docs/cpp_api/object/macros.md, Object, Macros]
71   -- [api_docs/cpp_api/object/statics.md, Object, Static Functions]
72   -- [api_docs/cpp_api/object/functions.md, Object, Functions]
73   -
74   -# Context
75   -- [api_docs/cpp_api/context/context.md, C++ Plugin API, Context]
76   -- [api_docs/cpp_api/context/members.md, Context, Members]
77   -- [api_docs/cpp_api/context/statics.md, Context, Static Functions]
78   -- [api_docs/cpp_api/context/functions.md, Context, Functions]
79   -
80   -# Initializer
81   -- [api_docs/cpp_api/initializer/initializer.md, C++ Plugin API, Initializer]
82   -- [api_docs/cpp_api/initializer/constructors.md, Initializer, Constructors]
83   -- [api_docs/cpp_api/initializer/functions.md, Initializer, Functions]
84   -
85   -# Transform
86   -- [api_docs/cpp_api/transform/transform.md, C++ Plugin API, Transform]
87   -- [api_docs/cpp_api/transform/members.md, Transform, Members]
88   -- [api_docs/cpp_api/transform/constructors.md, Transform, Constructors]
89   -- [api_docs/cpp_api/transform/statics.md, Transform, Static Functions]
90   -- [api_docs/cpp_api/transform/functions.md, Transform, Functions]
91   -
92   -# UntrainableTransform
93   -- [api_docs/cpp_api/untrainabletransform/untrainabletransform.md, C++ Plugin API, UntrainableTransform]
94   -- [api_docs/cpp_api/untrainabletransform/constructors.md, UntrainableTransform, Constructors]
95   -
96   -# MetaTransform
97   -- [api_docs/cpp_api/metatransform/metatransform.md, C++ Plugin API, MetaTransform]
98   -- [api_docs/cpp_api/metatransform/constructors.md, MetaTransform, Constructors]
99   -
100   -# UntrainableMetaTransform
101   -- [api_docs/cpp_api/untrainablemetatransform/untrainablemetatransform.md, C++ Plugin API, UntrainableMetaTransform]
102   -- [api_docs/cpp_api/untrainablemetatransform/constructors.md, UntrainableMetaTransform, Constructors]
103   -
104   -# MetadataTransform
105   -- [api_docs/cpp_api/metadatatransform/metadatatransform.md, C++ Plugin API, MetadataTransform]
106   -- [api_docs/cpp_api/metadatatransform/constructors.md, MetadataTransform, Constructors]
107   -- [api_docs/cpp_api/metadatatransform/functions.md, MetadataTransform, Functions]
108   -
109   -# UntrainableMetadataTransform
110   -- [api_docs/cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md, C++ Plugin API, UntrainableMetadataTransform]
111   -- [api_docs/cpp_api/untrainablemetadatatransform/constructors.md, UntrainableMetadataTransform, Constructors]
112   -
113   -# TimeVaryingTransform
114   -- [api_docs/cpp_api/timevaryingtransform/timevaryingtransform.md, C++ Plugin API, TimeVaryingTransform]
115   -- [api_docs/cpp_api/timevaryingtransform/members.md, TimeVaryingTransform, Members]
116   -- [api_docs/cpp_api/timevaryingtransform/constructors.md, TimeVaryingTransform, Constructors]
117   -- [api_docs/cpp_api/timevaryingtransform/functions.md, TimeVaryingTransform, Functions]
118   -
119   -# CompositeTransform
120   -- [api_docs/cpp_api/compositetransform/compositetransform.md, C++ Plugin API, CompositeTransform]
121   -- [api_docs/cpp_api/compositetransform/properties.md, CompositeTransform, Properties]
122   -- [api_docs/cpp_api/compositetransform/members.md, CompositeTransform, Members]
123   -- [api_docs/cpp_api/compositetransform/constructors.md, CompositeTransform, Constructors]
124   -- [api_docs/cpp_api/compositetransform/functions.md, CompositeTransform, Functions]
125   -
126   -# WrapperTransform
127   -- [api_docs/cpp_api/wrappertransform/wrappertransform.md, C++ Plugin API, WrapperTransform]
128   -- [api_docs/cpp_api/wrappertransform/properties.md, WrapperTransform, Properties]
129   -- [api_docs/cpp_api/wrappertransform/constructors.md, WrapperTransform, Constructors]
130   -- [api_docs/cpp_api/wrappertransform/functions.md, WrapperTransform, Functions]
131   -
132   -# Distance
133   -- [api_docs/cpp_api/distance/distance.md, C++ Plugin API, Distance]
134   -- [api_docs/cpp_api/distance/constructors.md, Distance, Constructors]
135   -- [api_docs/cpp_api/distance/statics.md, Distance, Static Functions]
136   -- [api_docs/cpp_api/distance/functions.md, Distance, Functions]
137   -
138   -# UntrainableDistance
139   -- [api_docs/cpp_api/untrainabledistance/untrainabledistance.md, C++ Plugin API, UntrainableDistance]
140   -
141   -# Output
142   -- [api_docs/cpp_api/output/output.md, C++ Plugin API, Output]
143   -- [api_docs/cpp_api/output/properties.md, Output, Properties]
144   -- [api_docs/cpp_api/output/members.md, Output, Members]
145   -- [api_docs/cpp_api/output/constructors.md, Output, Constructors]
146   -- [api_docs/cpp_api/output/statics.md, Output, Static Functions]
147   -- [api_docs/cpp_api/output/functions.md, Output, Functions]
148   -
149   -# MatrixOutput
150   -- [api_docs/cpp_api/matrixoutput/matrixoutput.md, C++ Plugin API, MatrixOutput]
151   -- [api_docs/cpp_api/matrixoutput/members.md, MatrixOutput, Members]
152   -- [api_docs/cpp_api/matrixoutput/statics.md, MatrixOutput, Static Functions]
153   -- [api_docs/cpp_api/matrixoutput/functions.md, MatrixOutput, Functions]
154   -
155   -# Format
156   -- [api_docs/cpp_api/format/format.md, C++ Plugin API, Format]
157   -- [api_docs/cpp_api/format/constructors.md, Format, Constructors]
158   -- [api_docs/cpp_api/format/statics.md, Format, Static Functions]
159   -- [api_docs/cpp_api/format/functions.md, Format, Functions]
160   -
161   -# Gallery
162   -- [api_docs/cpp_api/gallery/gallery.md, C++ Plugin API, Gallery]
163   -- [api_docs/cpp_api/gallery/properties.md, Gallery, Properties]
164   -- [api_docs/cpp_api/gallery/constructors.md, Gallery, Constructors]
165   -- [api_docs/cpp_api/gallery/statics.md, Gallery, Static Functions]
166   -- [api_docs/cpp_api/gallery/functions.md, Gallery, Functions]
167   -
168   -# FileGallery
169   -- [api_docs/cpp_api/filegallery/filegallery.md, C++ Plugin API, FileGallery]
170   -- [api_docs/cpp_api/filegallery/members.md, FileGallery, Members]
171   -- [api_docs/cpp_api/filegallery/constructors.md, FileGallery, Constructors]
172   -- [api_docs/cpp_api/filegallery/functions.md, FileGallery, Functions]
173   -
174   -# Representation
175   -- [api_docs/cpp_api/representation/representation.md, C++ Plugin API, Representation]
176   -- [api_docs/cpp_api/representation/constructors.md, Representation, Constructors]
177   -- [api_docs/cpp_api/representation/statics.md, Representation, Static Functions]
178   -- [api_docs/cpp_api/representation/functions.md, Representation, Functions]
179   -
180   -# Classifier
181   -- [api_docs/cpp_api/classifier/classifier.md, C++ Plugin API, Classifier]
182   -- [api_docs/cpp_api/classifier/constructors.md, Classifier, Constructors]
183   -- [api_docs/cpp_api/classifier/statics.md, Classifier, Static Functions]
184   -- [api_docs/cpp_api/classifier/functions.md, Classifier, Functions]
185   -
186   -- [api_docs/cl_api.md, API Docs, Command Line API]
187   -
188   -# Plugins
189   -- [api_docs/plugins/classification.md, Plugin Docs, Classification]
190   -- [api_docs/plugins/cluster.md, Plugin Docs, Cluster]
191   -- [api_docs/plugins/core.md, Plugin Docs, Core]
192   -- [api_docs/plugins/distance.md, Plugin Docs, Distance]
193   -- [api_docs/plugins/format.md, Plugin Docs, Format]
194   -- [api_docs/plugins/gallery.md, Plugin Docs, Gallery]
195   -- [api_docs/plugins/gui.md, Plugin Docs, GUI]
196   -- [api_docs/plugins/imgproc.md, Plugin Docs, Image Processing]
197   -- [api_docs/plugins/io.md, Plugin Docs, I/O]
198   -- [api_docs/plugins/metadata.md, Plugin Docs, Metadata]
199   -- [api_docs/plugins/output.md, Plugin Docs, Output]
200   -- [api_docs/plugins/video.md, Plugin Docs, Video]
  18 +- Home: index.md
  19 +- Install: install.md
  20 +- Tutorials: tutorials.md
  21 +- Contribute: contribute.md
  22 +
  23 +- API Documentation:
  24 + - Description: api_docs.md
  25 +
  26 + - C API:
  27 + - Description: api_docs/c_api.md
  28 + - Typedefs: api_docs/c_api/typedefs.md
  29 + - Functions: api_docs/c_api/functions.md
  30 +
  31 + - Command Line API: api_docs/cl_api.md
  32 +
  33 + - Python Wrapper API: api_docs/python_api.md
  34 +
  35 + - C++ Plugin API:
  36 + - Description: api_docs/cpp_api.md
  37 + - API Functions: api_docs/cpp_api/apifunctions.md
  38 +
  39 + - File:
  40 + - Description: api_docs/cpp_api/file/file.md
  41 + - Members: api_docs/cpp_api/file/members.md
  42 + - Constructors: api_docs/cpp_api/file/constructors.md
  43 + - Static Functions: api_docs/cpp_api/file/statics.md
  44 + - Functions: api_docs/cpp_api/file/functions.md
  45 +
  46 + - FileList:
  47 + - Description: api_docs/cpp_api/filelist/filelist.md
  48 + - Constructors: api_docs/cpp_api/filelist/constructors.md
  49 + - Static Functions: api_docs/cpp_api/filelist/statics.md
  50 + - Functions: api_docs/cpp_api/filelist/functions.md
  51 +
  52 + - Template:
  53 + - Description: api_docs/cpp_api/template/template.md
  54 + - Members: api_docs/cpp_api/template/members.md
  55 + - Constructors: api_docs/cpp_api/template/constructors.md
  56 + - Static Functions: api_docs/cpp_api/template/statics.md
  57 + - Functions: api_docs/cpp_api/template/functions.md
  58 +
  59 + - TemplateList:
  60 + - Description: api_docs/cpp_api/templatelist/templatelist.md
  61 + - Constructors: api_docs/cpp_api/templatelist/constructors.md
  62 + - Static Functions: api_docs/cpp_api/templatelist/statics.md
  63 + - Functions: api_docs/cpp_api/templatelist/functions.md
  64 +
  65 + - Factory:
  66 + - Description: api_docs/cpp_api/factory/factory.md
  67 + - Members: api_docs/cpp_api/factory/members.md
  68 + - Constructors: api_docs/cpp_api/factory/constructors.md
  69 + - Macros: api_docs/cpp_api/factory/macros.md
  70 + - Static Functions: api_docs/cpp_api/factory/statics.md
  71 +
  72 + - Object:
  73 + - Description: api_docs/cpp_api/object/object.md
  74 + - Members: api_docs/cpp_api/object/members.md
  75 + - Macros: api_docs/cpp_api/object/macros.md
  76 + - Static Functions: api_docs/cpp_api/object/statics.md
  77 + - Functions: api_docs/cpp_api/object/functions.md
  78 +
  79 + - Context:
  80 + - Description: api_docs/cpp_api/context/context.md
  81 + - Members: api_docs/cpp_api/context/members.md
  82 + - Static Functions: api_docs/cpp_api/context/statics.md
  83 + - Functions: api_docs/cpp_api/context/functions.md
  84 +
  85 + - Initializer:
  86 + - Description: api_docs/cpp_api/initializer/initializer.md
  87 + - Constructors: api_docs/cpp_api/initializer/constructors.md
  88 + - Functions: api_docs/cpp_api/initializer/functions.md
  89 +
  90 + - Transform:
  91 + - Description: api_docs/cpp_api/transform/transform.md
  92 + - Members: api_docs/cpp_api/transform/members.md
  93 + - Constructors: api_docs/cpp_api/transform/constructors.md
  94 + - Static Functions: api_docs/cpp_api/transform/statics.md
  95 + - Functions: api_docs/cpp_api/transform/functions.md
  96 +
  97 + - UntrainableTransform:
  98 + - Description: api_docs/cpp_api/untrainabletransform/untrainabletransform.md
  99 + - Constructors: api_docs/cpp_api/untrainabletransform/constructors.md
  100 +
  101 + - MetaTransform:
  102 + - Description: api_docs/cpp_api/metatransform/metatransform.md
  103 + - Constructors: api_docs/cpp_api/metatransform/constructors.md
  104 +
  105 + - UntrainableMetaTransform:
  106 + - Description: api_docs/cpp_api/untrainablemetatransform/untrainablemetatransform.md
  107 + - Constructors: api_docs/cpp_api/untrainablemetatransform/constructors.md
  108 +
  109 + - MetadataTransform:
  110 + - Description: api_docs/cpp_api/metadatatransform/metadatatransform.md
  111 + - Constructors: api_docs/cpp_api/metadatatransform/constructors.md
  112 + - Functions: api_docs/cpp_api/metadatatransform/functions.md
  113 +
  114 + - UntrainableMetadataTransform:
  115 + - Description: api_docs/cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md
  116 + - Constructors: api_docs/cpp_api/untrainablemetadatatransform/constructors.md
  117 +
  118 + - TimeVaryingTransform:
  119 + - Description: api_docs/cpp_api/timevaryingtransform/timevaryingtransform.md
  120 + - Members: api_docs/cpp_api/timevaryingtransform/members.md
  121 + - Constructors: api_docs/cpp_api/timevaryingtransform/constructors.md
  122 + - Functions: api_docs/cpp_api/timevaryingtransform/functions.md
  123 +
  124 + - CompositeTransform:
  125 + - Description: api_docs/cpp_api/compositetransform/compositetransform.md
  126 + - Properties: api_docs/cpp_api/compositetransform/properties.md
  127 + - Members: api_docs/cpp_api/compositetransform/members.md
  128 + - Constructors: api_docs/cpp_api/compositetransform/constructors.md
  129 + - Functions: api_docs/cpp_api/compositetransform/functions.md
  130 +
  131 + - WrapperTransform:
  132 + - Description: api_docs/cpp_api/wrappertransform/wrappertransform.md
  133 + - Properties: api_docs/cpp_api/wrappertransform/properties.md
  134 + - Constructors: api_docs/cpp_api/wrappertransform/constructors.md
  135 + - Functions: api_docs/cpp_api/wrappertransform/functions.md
  136 +
  137 + - Distance:
  138 + - Description: api_docs/cpp_api/distance/distance.md
  139 + - Constructors: api_docs/cpp_api/distance/constructors.md
  140 + - Static Functions: api_docs/cpp_api/distance/statics.md
  141 + - Functions: api_docs/cpp_api/distance/functions.md
  142 +
  143 + - UntrainableDistance:
  144 + - Description: api_docs/cpp_api/untrainabledistance/untrainabledistance.md
  145 +
  146 + - Output:
  147 + - Description: api_docs/cpp_api/output/output.md
  148 + - Properties: api_docs/cpp_api/output/properties.md
  149 + - Members: api_docs/cpp_api/output/members.md
  150 + - Constructors: api_docs/cpp_api/output/constructors.md
  151 + - Static Functions: api_docs/cpp_api/output/statics.md
  152 + - Functions: api_docs/cpp_api/output/functions.md
  153 +
  154 + - MatrixOutput:
  155 + - Description: api_docs/cpp_api/matrixoutput/matrixoutput.md
  156 + - Members: api_docs/cpp_api/matrixoutput/members.md
  157 + - Static Functions: api_docs/cpp_api/matrixoutput/statics.md
  158 + - Functions: api_docs/cpp_api/matrixoutput/functions.md
  159 +
  160 + - Format:
  161 + - Description: api_docs/cpp_api/format/format.md
  162 + - Constructors: api_docs/cpp_api/format/constructors.md
  163 + - Static Functions: api_docs/cpp_api/format/statics.md
  164 + - Functions: api_docs/cpp_api/format/functions.md
  165 +
  166 + - Gallery:
  167 + - Description: api_docs/cpp_api/gallery/gallery.md
  168 + - Properties: api_docs/cpp_api/gallery/properties.md
  169 + - Constructors: api_docs/cpp_api/gallery/constructors.md
  170 + - Static Functions: api_docs/cpp_api/gallery/statics.md
  171 + - Functions: api_docs/cpp_api/gallery/functions.md
  172 +
  173 + - FileGallery:
  174 + - Description: api_docs/cpp_api/filegallery/filegallery.md
  175 + - Members: api_docs/cpp_api/filegallery/members.md
  176 + - Constructors: api_docs/cpp_api/filegallery/constructors.md
  177 + - Functions: api_docs/cpp_api/filegallery/functions.md
  178 +
  179 + - Representation:
  180 + - Description: api_docs/cpp_api/representation/representation.md
  181 + - Constructors: api_docs/cpp_api/representation/constructors.md
  182 + - Static Functions: api_docs/cpp_api/representation/statics.md
  183 + - Functions: api_docs/cpp_api/representation/functions.md
  184 +
  185 + - Classifier:
  186 + - Description: api_docs/cpp_api/classifier/classifier.md
  187 + - Constructors: api_docs/cpp_api/classifier/constructors.md
  188 + - Static Functions: api_docs/cpp_api/classifier/statics.md
  189 + - Functions: api_docs/cpp_api/classifier/functions.md
  190 +
  191 +- Plugin Documentation:
  192 + - Description: plugin_docs.md
  193 + - Classification: api_docs/plugins/classification.md
  194 + - Cluster: api_docs/plugins/cluster.md
  195 + - Core: api_docs/plugins/core.md
  196 + - Distance: api_docs/plugins/distance.md
  197 + - Format: api_docs/plugins/format.md
  198 + - Gallery: api_docs/plugins/gallery.md
  199 + - GUI: api_docs/plugins/gui.md
  200 + - Image Processing: api_docs/plugins/imgproc.md
  201 + - I/O: api_docs/plugins/io.md
  202 + - Metadata: api_docs/plugins/metadata.md
  203 + - Output: api_docs/plugins/output.md
  204 + - Video: api_docs/plugins/video.md
... ...
docs/scripts/generate_plugin_docs.py
  View file @d4831be
... ... @@ -212,7 +212,9 @@ def parseFormats(formats):
212 212 def main():
213 213 plugins_dir = '../../openbr/plugins/'
214 214 output_dir = '../docs/api_docs/plugins/'
215   -
  215 + if not os.path.exists(output_dir):
  216 + os.mkdir(output_dir)
  217 +
216 218 for module in subdirs(plugins_dir):
217 219 if module == "cmake":
218 220 continue
... ...