GNOME Bugzilla – Bug 767047
Error in Vapi file cause Valadoc to fail
Last modified: 2016-07-21 13:57:43 UTC
Created attachment 328770 [details] [review] Diff file to correct Vapi file errror The comment block on line 1919 is malformed and causes Valadoc to error. Patch attached.
Review of attachment 328770 [details] [review]: Thanks for picking up on this, it was my patch that added crypt. Two points: - valadoc seems to take brief description and long description, so should the first line be "A string encoding function." Taken from http://pubs.opengroup.org/onlinepubs/9699919799/functions/crypt.html This should then appear as the tooltip against the function. Untested though as valdoc.org is currently down. Then there should probably be an empty line before the advice about the valac switches - git formatted patch?
Created attachment 329891 [details] [review] Updated diff file This patch is the full git diff and adds an extra line allowing the top line to be displayed as a Tool Tip by Valadoc.
Created attachment 329899 [details] [review] Correct documentation comment for crypt() git formatted patch with "Encodes a string" as short description (tooltip). To apply without committing: git apply 0001-posix-Correct-documentation-comment-for-crypt.patch To apply and commit in one go: git am 0001-posix-Correct-documentation-comment-for-crypt.patch Can you check the patch works for you and review as accepted-commit_now ? The advantage of a git formatted patch is it includes the authors name and a message for the commit log. A git formatted patch can be created after a single local commit with: git format-patch HEAD^1
(In reply to Al Thomas from comment #3) That works just fine, thanks for the patch tip.
Review of attachment 329891 [details] [review]: As per comments above
Review of attachment 329899 [details] [review]: As per comments above