Documentation for Pointer, Type, Type::Builtin, Type::Mapped, NativeType, StrPtrConverter #155
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FFI::Type::Mapped, FFI::NativeType, FFI::StrPtrConverter. Minor correction for FFI::AbstractMemory#put_bytes (old doc seems to be for #get_bytes).
ghost
pushed a commit
that referenced
this pull request
Sep 20, 2011
Documentation for Pointer, Type, Type::Builtin, Type::Mapped, NativeType, StrPtrConverter
skull-squadron
added a commit
to skull-squadron/ffi
that referenced
this pull request
May 15, 2023
|
Lol oops I meant closes libvips/#155. Nothing to see here, move along. :P |
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation for FFI::Pointer, FFI::Type, FFI::Type::Builtin, FFI::Type::Mapped, FFI::NativeType, FFI::StrPtrConverter.
Minor correction for FFI::AbstractMemory#put_bytes (old doc seems to be for #get_bytes).
I have some problems with documentation due to RDoc which uses variable names to guess parent class from rb_define_class or rb_define_class_under. As varibale are named "NameClass" (where "Name" is the class name), RDoc guesses parent class is NameClass instead of Name.
A typical example is FFI::Pointer. As its parent is guessed AbstractMemoryClass, no link to browse to AbstractMemory documentation page appears on Pointer page.
I think this is harmful for documentation quality and for easiness to use.
Here is my question : may I change name variables in my future work by using a ruby-like naming style (rbffi_cName instead of rbffi_NameClass by example).