gio/gsocketaddressenumerator.c · 2.84.1 · GNOME / GLib · GitLab (original) (raw)

Skip to content

• glib

• gio

• gsocketaddressenumerator.c

• 
  Fix pointer-to-paramref syntax in docs · 9f016e5d
  The documentation for GLib and Gio contains a number of documentation
  comment blocks where a parameter reference (e.g. @err) is also
  discussed in its dereferenced pointer form, which is generally
  annotated as *@err. This inevitably confuses the MarkDown parser,
  which sees the * as the beginning of an italicized text span.
  To avoid this, replace all *@foo with *foo, which
  loses the @-sigil linking it to the @foo parameter, but formats
  correctly in the rendered documentation. (@foo is automatically
  formatted like foo, so the resulting appearance in
  the docs is as intended.)
  Fix pointer-to-paramref syntax in docs
  The documentation for GLib and Gio contains a number of documentation
  comment blocks where a parameter reference (e.g. @err) is also
  discussed in its dereferenced pointer form, which is generally
  annotated as *@err. This inevitably confuses the MarkDown parser,
  which sees the * as the beginning of an italicized text span.
  To avoid this, replace all *@foo with *foo, which
  loses the @-sigil linking it to the @foo parameter, but formats
  correctly in the rendered documentation. (@foo is automatically
  formatted like foo, so the resulting appearance in
  the docs is as intended.)