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 384249 - Multiline macro argument lists look bad
Multiline macro argument lists look bad
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2006-12-10 03:22 UTC by Hans Petter Jansson
Modified: 2007-01-16 20:54 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Header file with example macros. (30.05 KB, text/x-chdr)
2007-01-15 23:20 UTC, Hans Petter Jansson
Details

Description Hans Petter Jansson 2006-12-10 03:22:25 UTC
If the argument list of a macro is split over several lines using backslash continuation, gtk-doc's reproduction looks bad. I suggest we remove the backslashes and correct the spacing of consecutive lines (currently it uses the source file's spacing).
Comment 1 Hans Petter Jansson 2006-12-10 03:26:30 UTC
See bug #384247 for a patch.
Comment 2 Hans Petter Jansson 2006-12-10 03:28:03 UTC
The macro fix is the added $declaration =~ ... line.
Comment 3 Damon Chaplin 2006-12-17 12:14:30 UTC
I'm a bit unsure about applying this one, as some macros can be extremely
lengthy and complicated (e.g. in Glib/GTK+) so getting gtk-doc to format
the output may make it worse.

I'll have to see what difference it makes to the Glib and GTK+ docs to decide.
Comment 4 Hans Petter Jansson 2006-12-17 23:12:33 UTC
But then, you don't show the macro itself when it's very long or complicated. I'd be fine with doing this only to the macro arguments, myself.
Comment 5 Damon Chaplin 2007-01-04 17:55:24 UTC
Can you give me an example macro that I can test this with.
Comment 6 Hans Petter Jansson 2007-01-15 23:20:45 UTC
Created attachment 80346 [details]
Header file with example macros.

Here's a header file containing example macros with multiline argument lists. E.g. FLOW_GOBJECT_PROPERTY(...).
Comment 7 Damon Chaplin 2007-01-16 20:54:17 UTC
Yes, I see what you mean now.

Should be better now.