search

jstedfast / gmime

A C/C++ MIME creation and parser library with support for S/MIME, PGP, and Unix mbox spools.
GNU Lesser General Public License v2.1
111 stars 36 forks source link

gmime-format-options.h: bad <a> #131

Closed jwilk closed 1 year ago

jwilk commented 1 year ago

gmime/gmime-format-options.h says:

 * Content-Disposition parameter values is the method described in
 * <a href="https://tools.ietf.org/html/rfc2231">rfc2231</a>. However, it is common for
 * some older email clients to improperly encode using the method described in
 * <a href="https://tools.ietf.org/html/rfc2047">rfc2047</a> instead.

But the <a href="…"> syntax doesn't seem to be understood by documentation generators. In https://developer-old.gnome.org/gmime/stable/gmime-GMimeFormatOptions.html#GMimeParamEncodingMethod, this fragment shows up as:

The MIME specifications specify that the proper method for encoding Content-Type and Content-Disposition parameter values is the method described in <a>rfc2231</a>. However, it is common for some older email clients to improperly encode using the method described in <a>rfc2047</a> instead.

jstedfast commented 1 year ago

Ugh, thanks for the heads-up on that. I might just kill the href links.

jwilk commented 1 year ago

According to https://wiki.gnome.org/DocumentationProject/GtkDoc#Linking, you can use <ulink url="…"> instead.

jstedfast commented 1 year ago

Of course, now that the docs are fixed in gmime's source repo, I don't think they can be updated on developer-old.gnome.org anymore (I think that's been archived).

The docs used to get regenerated every release, but they don't anymore.