Fix cross-referencing in gplugin docs

Review Request #999 — Created Oct. 5, 2021 and submitted

QuLogic
gplugin/gplugin
default
dda48e761c53
pidgin

gi-docgen already puts types on most documented things. Thus most of this is replacing the linking with normal text.

But otherwise things are linked into GLib, internally, etc.

  • Improve documentation of manager
    For parameters, dropped the types because gi-docgen shows them automatically. It also shows transfer full, etc., so don't write extra notes about referencing and freeing.
    The types are not correctly shown on signals, which are kept in docs.
    Also, break up some paragraphs so that the details are not shown in the summaries on the overview page for the Manager.
  • Clean up loader docs
    Most of the links are not needed, so this just makes them normal text.
  • Fix doc cross-references in plugin info
    Like before, most of this is actually removing extra cross-references, but there are still one or two left.
  • Clean up cross references in plugin interface
  • Fix cross-referencing in top-level functions

Compiled and looked at docs in the browser.

Description From Last Updated

loader

grimgrim

This should probably be something like "An error that was returned if the plugin failed to load or unload."

grimgrim
grim
grim
  1. 
      
  2. gplugin/gplugin-loader.c (Diff revision 1)
     
     
  3. gplugin/gplugin-plugin.c (Diff revision 1)
     
     

    This should probably be something like "An error that was returned if the plugin failed to load or unload."

  4. 
      
QuLogic
grim
  1. Ship It!
  2. Nice work!!

  3. 
      
grim
Review request changed

Status: Closed (submitted)

Loading...