gh-libusb/hidapi
Watch
1
0
Fork
You've already forked hidapi
 0
Code Issues 58 Pull requests 18 Releases 13 Wiki Activity

Missing man pages, incomplete documentation in headers. #357

New issue
Open
opened 2021-12-16 11:06:46 -06:00 by stolk · 1 comment
stolk commented 2021-12-16 11:06:46 -06:00 (Migrated from github.com)

This library is missing manual pages.

$ man hid_write
No manual entry for hid_write

Even in the header files, documentation is lacking. The largest omissions:

  • No mention whether hid_write() blocks.
  • No mention whether hid_close() flushes written data.
This library is missing manual pages. ``` $ man hid_write No manual entry for hid_write ``` Even in the header files, documentation is lacking. The largest omissions: * No mention whether `hid_write()` blocks. * No mention whether `hid_close()` flushes written data.
👍 1
Youw commented 2023-03-12 08:01:57 -05:00 (Migrated from github.com)

Any external help/PRs are welcome here.

Any external help/PRs are welcome here.
👍 1
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
read-interrupt
connection-callback-2
hotplug-async-enumerate-libusb
hotplug-tests-integration
hotplug-async-enumerate-mac
hotplug-tests
hotplug-async-enumerate-windows
hotplug-async-enumerate-linux
hotplug-docs-consistency
archive/20260923T145431Z-rescue/falkTX/linux-dynamic-libudev
gh-pages
archive/20260923T145431Z-rescue/aokblast/use_hid_raw
archive/20260923T145431Z-rescue/sudobash1/libusb_input_size
hotplug-integration
connection-callback
read-interrupt-win-test
archive/20260923T145431Z-rescue/auxcorelabs/feature/input-report-buffer-size
archive/20260923T145431Z-rescue/FrameworkComputer/hid-firmware-ver
archive/20260923T145431Z-rescue/slouken/0001-hidapi-linux-retry-hid_send_feature_report-if-the-io.patch
archive/20260923T145431Z-rescue/slouken/0001-hidapi-libusb-maintain-in-memory-cache-of-vendor-pro.patch
archive/20260923T145431Z-rescue/slouken/0001-hidapi-windows-fixed-PS4-controllers-over-Bluetooth-.patch
winrt
hidapi-0.15.0
hidapi-0.14.0
hidapi-0.13.1
hidapi-0.13.0
hidapi-0.12.0
hidapi-0.12.0-rc2
hidapi-0.12.0-rc1
hidapi-0.11.2
hidapi-0.11.1
hidapi-0.11.0
cmake-support-deprecated
libusb_wrap_device-deprecated
hidapi-0.10.1
hidapi-0.10.0
hidapi-0.9.0
hidapi-0.9.0-rc1
hidapi-0.8.0-rc1
hidapi-0.7.0
hidapi-0.6.0
hidapi-0.5.2
hidapi-0.5.1
hidapi-0.5.0
hidapi-0.3.0
hidapi-0.2.4
hidapi-0.2.3
hidapi-0.2.2
hidapi-0.1.0
Labels
Clear labels   
3rdparty
3rd-party related issue/question

  
Android
Android OS related

  
API
API change, Version 1 stuff

  
Author does not respond

   
bsd
FreeBSD, NetBSD, OpenBSD, etc

  
bug
Something isn't working

  
build system/CI
Anything related to building the project or running on CI

  
ci-virtual-device
Run the virtual HID device CI jobs (Windows driver + libusb raw-gadget)

  
CMake
Related to CMake build system

  
Contributions Welcome
Any external help is welcome

  
Core
Related to common codes like hidapi.h

  
dependencies
Pull requests that update a dependency file

  
device-specific
Issues/PRs related to a specific device

  
documentation
Improvements or additions to documentation

  
don't_merge
Don't merge this PR as is

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
Example
Related to hidtest or new examples

  
Haiku
Related to Haiku OS (using libusb backend)

  
hidraw
Related to Linux/hidraw backend

  
hotplug
Related to hotplug

  
info required
Need more input from PR/issue author

  
invalid
Not a HIDAPI issue

  
libusb
Related to libusb backend

  
macOS
Related to macOS backend

  
Misc
Typo, whitespace, etc.

  
Not an issue

   
question
Information is requested

  
Release
Related to new release

  
Test
Related to built-in test (not hidtest)

  
Test GUI
Related to a Test GUI application

  
Windows
Related to Windows backend

  
wontfix
This will not be worked on

No labels
3rdparty
Android
API
Author does not respond
bsd
bug
build system/CI
ci-virtual-device
CMake
Contributions Welcome
Core
dependencies
device-specific
documentation
don't_merge
duplicate
enhancement
Example
Haiku
hidraw
hotplug
info required
invalid
libusb
macOS
Misc
Not an issue
question
Release
Test
Test GUI
Windows
wontfix
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
gh-libusb/hidapi#357
No description provided.