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 728285 - docs: Use markdown links in .h files, too
docs: Use markdown links in .h files, too
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
2.40.x
Other All
: Normal normal
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2014-04-15 18:40 UTC by Volker Sobek (weld)
Modified: 2014-04-15 20:23 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
docs: Use markdown links in .h files, too (5.28 KB, patch)
2014-04-15 18:40 UTC, Volker Sobek (weld)
none Details | Review
my patch (5.26 KB, patch)
2014-04-15 18:52 UTC, Matthias Clasen
none Details | Review
docs: Use markdown links in .h files, too (8.26 KB, patch)
2014-04-15 19:55 UTC, Volker Sobek (weld)
accepted-commit_now Details | Review

Description Volker Sobek (weld) 2014-04-15 18:40:13 UTC
Commit e7fd3de86d60 already did this for all .c files.

This patch does not change the links to 'extending-gio' as these links
are broken since long and changing them to markdown would result in no
visible links and hide this problem.
Comment 1 Volker Sobek (weld) 2014-04-15 18:40:15 UTC
Created attachment 274391 [details] [review]
docs: Use markdown links in .h files, too
Comment 2 Matthias Clasen 2014-04-15 18:52:18 UTC
Created attachment 274393 [details] [review]
my patch

Hmm, I have a patch that overlaps with yours - maybe you could merge the two and commit it all in one go ?
Comment 3 Volker Sobek (weld) 2014-04-15 19:29:16 UTC
OK, but there are more <!-- comments still, how can these be fixed? Seems like plurals are recognized automatically(?) but what about @t_n<!-- -->_parent_class ?

./gclosure.h:105: *  #GValue<!-- -->s holding the arguments on which to invoke the
./gtypemodule.h:94: * @t_n<!-- -->_parent_class pointing to the parent class. Furthermore, 
./gtype.h:929: * Returns: %TRUE to stop further #GTypeClassCacheFunc<!-- -->s from being 
./gtype.h:1320: * these) and a static variable named @t_n<!-- -->_parent_class pointing to the parent class. Furthermore, it defines 
./gtype.h:1350: * these), a static variable named @t_n<!-- -->_parent_class pointing to the parent class, and adds private
./gvaluecollector.h:247: * The maximal number of #GTypeCValue<!-- -->s which can be collected for a 
./gclosure.c:54: * other languages need marshallers which convert between #GValue<!--
Comment 4 Volker Sobek (weld) 2014-04-15 19:38:13 UTC
(Accidentally just greped in a subdir above, btw, but there are just a few more <!-- comments all in all)
Comment 5 Volker Sobek (weld) 2014-04-15 19:55:21 UTC
Created attachment 274399 [details] [review]
docs: Use markdown links in .h files, too

Commit e7fd3de86d60 already did this for all .c files.
Comment 6 Volker Sobek (weld) 2014-04-15 20:00:39 UTC
(In reply to comment #5)
Included the [Extending GIO][extending-gio] links too now (though they are still broken and don't show up in the html (bug 728283).

I think dealing with the <!-- comments should go in another commit once we decide on how to deal with the @t_n<!-- -->_parent_class stuff?
Comment 7 Matthias Clasen 2014-04-15 20:09:30 UTC
(In reply to comment #6)
> (In reply to comment #5)
> Included the [Extending GIO][extending-gio] links too now (though they are
> still broken and don't show up in the html (bug 728283).
> 
> I think dealing with the <!-- comments should go in another commit once we
> decide on how to deal with the @t_n<!-- -->_parent_class stuff?

I agree. A separate commit for that is better
Comment 8 Matthias Clasen 2014-04-15 20:11:47 UTC
Review of attachment 274399 [details] [review]:

Looks good