luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-27 06:26:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'tintou/gdbus-codegen-doc' into 'main'

Browse Source 
docs: Add --generate-md to the gdbus-codegen documentation

See merge request GNOME/glib!4436
This commit is contained in:
Philip Withnall 2024-12-12 11:51:49 +00:00
commit ad3e0a6597
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/reference/gio/gdbus-codegen.rst
View File

@ -39,6 +39,7 @@ SYNOPSIS
| [--c-generate-autocleanup none|objects|all]
| [--output-directory *OUTDIR* | --output *OUTFILE*]
| [--generate-docbook *OUTFILES*]
| [--generate-md *OUTFILES*]
| [--generate-rst *OUTFILES*]
| [--pragma-once]
| [--xml-files *FILE*]
@ -120,6 +121,12 @@ Each generated DocBook XML file (see the ``--generate-docbook`` option for
details) is a ``RefEntry`` article describing the D-Bus interface. (See the
`DocBook documentation <https://tdg.docbook.org/tdg/4.5/refentry.html>`_.)
GENERATING MARKDOWN DOCUMENTATION
-----------------------------------------
Each generated Markdown file (see the ``--generate-md`` option for
details) is a plain text Markdown document describing the D-Bus interface.
GENERATING RESTRUCTUREDTEXT DOCUMENTATION
-----------------------------------------
@ -157,6 +164,15 @@ The following options are supported:
Pass ``--output-directory`` to specify the directory to put the output files
in. By default the current directory will be used.
``--generate-md`` *OUTFILES*
Generate Markdown Documentation for each D-Bus interface and put it in
``OUTFILES-NAME.md`` where ``NAME`` is a placeholder for the interface
name, e.g. ``net.Corp.FooBar`` and so on.
Pass ``--output-directory`` to specify the directory to put the output files
in. By default the current directory will be used.
``--generate-rst`` *OUTFILES*
Generate reStructuredText Documentation for each D-Bus interface and put it in