Fix documentation generation #16

Merged

z3ntu merged 3 commits from doxygen into master

2019-06-17 04:32:49 -05:00

z3ntu commented

2019-06-09 04:07:28 -05:00

(Migrated from github.com)

The first commit is auto-generated with doxygen -u

The second commit fixes most of the doc generation being wrong, because the "relative indentation" in hidapi.h comments was being intepreted as codeblocks.

The third commit fixes a warning because in the hid_read_timeout documentation the parameter-name "device" was used but the function used "dev". As all other functions use "device", adjust the function.

The first commit is auto-generated with `doxygen -u` The second commit fixes most of the doc generation being wrong, because the "relative indentation" in hidapi.h comments was being intepreted as codeblocks. The third commit fixes a warning because in the hid_read_timeout documentation the parameter-name "device" was used but the function used "dev". As all other functions use "device", adjust the function.

Youw commented

2019-06-09 20:20:18 -05:00

(Migrated from github.com)

The result looks good, but doxygen -u gives so unreadable diff.
Maybe manually change only what need to be updated (remove obsolete/add missing options)?

The result looks good, but `doxygen -u` gives so unreadable diff. Maybe manually change only what need to be updated (remove obsolete/add missing options)?

z3ntu commented

2019-06-10 05:16:36 -05:00

(Migrated from github.com)

That's why I made them separate commits - but future updates to the Doxyfile should be much smaller as this is a bump over several years of versions (if it's needed at all).

Youw (Migrated from github.com) approved these changes

2019-06-12 18:32:57 -05:00

Qbicz (Migrated from github.com) requested changes

2019-06-17 00:46:18 -05:00

hidapi/hidapi.h

In all implementations (in .c files) there is dev. I would prefer to change doxygen text to @param dev instead of changing dev to device in function declaration.

In all implementations (in .c files) there is `dev`. I would prefer to change doxygen text to `@param dev` instead of changing `dev` to `device` in function declaration.

Qbicz (Migrated from github.com) reviewed

2019-06-17 00:47:00 -05:00

hidapi/hidapi.h

And rename commit title accordingly

Youw (Migrated from github.com) reviewed

2019-06-17 01:52:03 -05:00

hidapi/hidapi.h

On the other hand - in all other places in this .h - it is device, so either we rename everywhere, or have device everywhere (I prefer more readable form for documentation).

On the other hand - in all other places in this `.h` - it is `device`, so either we rename everywhere, or have `device` everywhere (I prefer more readable form for documentation).