~hedgepigdaniel/dewobble

f452558b5ec940bed4736d46951c3789e4d60bec — Daniel Playfair Cal 2 years ago 27d9311
docs: Doxygen improvements
3 files changed, 9 insertions(+), 6 deletions(-)

M Doxyfile
M README.md
M include/filter_sync.hpp
M Doxyfile => Doxyfile +5 -5
@@ 518,7 518,7 @@ EXTRACT_STATIC         = NO
# for Java sources.
# The default value is: YES.

EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_CLASSES  = NO

# This flag is only useful for Objective-C code. If set to YES, local methods,
# which are defined in the implementation section but not in the interface are


@@ 641,7 641,7 @@ INLINE_INFO            = YES
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.

SORT_MEMBER_DOCS       = YES
SORT_MEMBER_DOCS       = NO

# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member


@@ 649,7 649,7 @@ SORT_MEMBER_DOCS       = YES
# this will also influence the order of the classes in the class list.
# The default value is: NO.

SORT_BRIEF_DOCS        = NO
SORT_BRIEF_DOCS        = yes

# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and


@@ 661,7 661,7 @@ SORT_BRIEF_DOCS        = NO
# detailed member documentation.
# The default value is: NO.

SORT_MEMBERS_CTORS_1ST = NO
SORT_MEMBERS_CTORS_1ST = YES

# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will


@@ 944,7 944,7 @@ FILE_PATTERNS          = *.c \
# be searched for input files as well.
# The default value is: NO.

RECURSIVE              =
RECURSIVE              = YES

# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a

M README.md => README.md +1 -1
@@ 60,7 60,7 @@ These benchmarks are collected by using the in development `dewobble_opencl` FFm

## Usage
### c++
```C++
```cpp
#include <dewobble/filter_threaded.hpp>

dewobble::Camera input_camera(

M include/filter_sync.hpp => include/filter_sync.hpp +3 -0
@@ 64,6 64,9 @@ class FilterSync : public FilterBase

    void pull_frame(cl_mem *output_buffer, cl_mem *input_buffer, void **extra);

    /**
     * @copydoc FilterBase::get_output_frame_buffer()
     */
    cl_mem get_output_frame_buffer();
};
} // namespace dewobble