[doc] Fix Doxygen parameter names in io and the extensions - #793
Merged
Conversation
A follow-up to boostorg#792, same check on the parts of the library it did not reach. - read_and_convert_view.hpp: all four Device overloads document \param file, the argument is device. The descriptions already say "It's a device", so only the names were wrong. - read_and_convert_image.hpp: the Device overload at 241 documents file_name with the string overload's description. The other three Device overloads in the same file (47, 134, 189) get this right and were used as the model. - reader_base.hpp: init_image documents @param info, the argument is settings. - extension/io/png/tags.hpp: the image_read_settings constructor documents \param gamma, the argument is screen_gamma. - extension/dynamic_image/algorithm.hpp: the two-argument copy_and_convert_pixels documents \tparam Type, the pack is Types. The three-argument overload twenty lines above spells it correctly. - extension/dynamic_image/any_image.hpp: const_view documents \tparam Types, the pack is Images. view() right above it is correct. read_view.hpp, read_image.hpp and the other Device overloads really do name the argument file, and their \param file is correct. Those are untouched. Comments only.
Member
|
Thank you! Let's leave the unnamed parameters as they are. I think it was my preference to use the east-const convention, see https://hackingcpp.com/cpp/design/east_vs_west_const |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Follow-up to #792, covering the parts of the library that PR deliberately left out. I said there I would send these if wanted; Marshall Clow also suggested it in boostorg/algorithm#131 after merging the same kind of fix there. If you would rather not have them, close this and nothing is lost.
Nine
\param/\tparamnames that do not match the declaration below them.io
read_and_convert_view.hpp— all fourDeviceoverloads document\param file, the argument isdevice. The descriptions already read "It's a device", so only the names were wrong.read_and_convert_image.hpp:241— theDeviceoverload documentsfile_name File name. Must satisfy is_supported_path_spec metafunction., which is the string overload's line copied down. The three otherDeviceoverloads in the same file (47, 134, 189) already saydevice, and I followed the one at 189 word for word.reader_base.hpp:50—init_imagedocuments@param info, the argument issettings.extensions
extension/io/png/tags.hpp:681— theimage_read_settingsconstructor documents\param gamma, the argument isscreen_gamma.extension/dynamic_image/algorithm.hpp:155— the two-argumentcopy_and_convert_pixelsdocuments\tparam Type, the pack isTypes. The three-argument overload eleven lines above spells it correctly, so the two overloads describe the same pack differently.extension/dynamic_image/any_image.hpp:162—const_viewdocuments\tparam Types, the pack isImages.view()directly above it is correct.Checked and left alone
read_view.hpp,read_image.hppand the remainingDeviceoverloads genuinely name the argumentfile, so their\param fileis right. GIL uses both spellings and I did not touch that.Two I did not fix, and why
io/read_image_info.hpp:46and:89document\param tagon overloads whose second parameter is unnamed (FormatTag const&). So the name really is absent, but the fix would mean naming a parameter in the signature rather than editing a comment, and that is your call rather than mine.My checker also gets these two wrong in a way worth stating: it reports the parameter list as
file, const, dummy, readingconstinFormatTag const&as an argument name. So treat the two counts above as nine verified by hand, not eleven from a tool.One more, not a mismatch so not included: the same png constructor never documents
apply_screen_gammaat all.Checks
Comments only, the diff has no non-comment lines. Re-running the same check on this branch reports 0 remaining in
ioand the extensions, down from 11 ondevelopat dcfcc69.