You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
C libraries are not always very careful about documenting their safety requirements. But unsafe rust functions are expected to document in which circumstances they are safe to use. To resolve this impedance mismatch without huge upstream doc contributions, which may be rejected, it would be nice if one could append manually written # Safety sections to bindgen's autogenerated function docs. This could take the form of a HashMap from C function name to safety docs.
The text was updated successfully, but these errors were encountered:
HadrienG2
changed the title
Allow adding extra lines to a type's autogenerated documentation
Allow adding extra documentation to bindgen-generated entities
Feb 12, 2024
C libraries are not always very careful about documenting their safety requirements. But unsafe rust functions are expected to document in which circumstances they are safe to use. To resolve this impedance mismatch without huge upstream doc contributions, which may be rejected, it would be nice if one could append manually written
# Safety
sections to bindgen's autogenerated function docs. This could take the form of a HashMap from C function name to safety docs.The text was updated successfully, but these errors were encountered: