After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 646982 - Fails to parse @link tag split over two lines
Fails to parse @link tag split over two lines
Status: RESOLVED FIXED
Product: valadoc
Classification: Other
Component: libvaladoc/parser
git master
Other Linux
: Normal normal
: ---
Assigned To: valadoc-maint
valadoc-maint
Depends on:
Blocks:
 
 
Reported: 2011-04-07 01:58 UTC by Jim Peters
Modified: 2018-01-09 13:09 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Allow @link tags to be split over multiple lines (2.10 KB, patch)
2018-01-09 01:47 UTC, Michael Gratton
committed Details | Review

Description Jim Peters 2011-04-07 01:58:06 UTC
When a comment is word-wrapped by the editor, the {@link test} construction may be broken across two lines.  Valadoc fails to parse it in this case, giving an error.  For example:

/w2/v/cwrk/vala/uazu/con/Area.vala:52.56-52.57: error: expected <space>: <end-of-line>
       * When it changes from false to true, the {@link
                                                       ^
Comment 1 Michael Gratton 2018-01-09 01:47:38 UTC
Created attachment 366526 [details] [review]
Allow @link tags to be split over multiple lines

Patch adds support for multi-line links. It also had to touch the generic link tag rule, since that also imposed a SP-only requirement to separate the tag name and its body, and that's where the NL if any will be found.

I guess this is more or less safe to commit, since currently it's pretty strict and hence most (all?) existing uses of tags would be generating errors if they were split along new lines anyway?

This fixes all instances of the issue in Geary's codebase, which (along with Bug 736483) makes Geary's engine API docs build again. Yay! :)
Comment 2 Rico Tzschichholz 2018-01-09 13:09:33 UTC
commit a52b4ac85ba48bb334d68976b94448cc66ce6f83
Author: Michael James Gratton <mike@vee.net>
Date:   Tue Jan 9 12:36:43 2018 +1100

    libvaladoc: Allow @link tags to be split over multiple lines