Skip to content

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

Closed

Description

@jwilk

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.

Activity

  1. jstedfast commented on Oct 13, 2022

    @jstedfast
    Owner

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

  2. jwilk commented on Oct 13, 2022

    @jwilk
    ContributorAuthor

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

  3. jstedfast commented on Oct 13, 2022

    @jstedfast
    Owner

    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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions