Port all documentation comments to gi-docgen
This has been split out from #3037 (closed), as it’ll take a while to finish and isn’t on the critical path for switching from gtk-doc to gi-docgen as gi-docgen can generate passable documentation from gtk-doc-format comments.
Each documentation comment in GLib (any comment starting with /**
) needs to be changed to:
- use gi-docgen links
- use proper code blocks (with syntax highlighting) (three backticks followed by the name of the language used in the code block)
- ensure that every indented Markdown line is using 2 spaces (not more) to avoid being identified as a pre-formatted block
- in general, follow the style guidelines for developer documentation
- keep the documentation line wrapped at 80 characters, as is the code style
The changes need to absolutely not introduce any new errors to the documentation. Find-and-replace will not work for this task.
An example of the required changes can be seen at !3801 (merged).
Files still to be ported
-
gio/gaction.c
: !3969 (merged), !3986 (merged) -
gio/gactiongroup.c
: !4002 (merged) -
gio/gactiongroupexporter.c
: !4113 (merged) -
gio/gactionmap.c
: !4113 (merged) -
gio/gappinfo.c
: partially done in !4113 (merged) -
gio/gappinfo.h
: !4113 (merged) -
gio/gapplication.c
-
gio/gapplication.h
-
gio/gapplicationcommandline.c
-
gio/gasyncinitable.c
-
gio/gasyncinitable.h
-
gio/gasyncresult.c
: !4128 (merged) -
gio/gasyncresult.h
: !4128 (merged) -
gio/gbufferedinputstream.c
: !4146 (merged) -
gio/gbufferedoutputstream.c
: !4148 (merged) -
gio/gbytesicon.c
-
gio/gcancellable.c
-
gio/gcharsetconverter.c
-
gio/gcontenttype.c
-
gio/gconverter.c
-
gio/gconverter.h
-
gio/gconverterinputstream.c
-
gio/gconverteroutputstream.c
-
gio/gcredentials.c
-
gio/gdatagrambased.c
-
gio/gdatagrambased.h
-
gio/gdatainputstream.c
-
gio/gdataoutputstream.c
-
gio/gdbusactiongroup.c
-
gio/gdbusaddress.c
-
gio/gdbusauthmechanism.c
-
gio/gdbusauthobserver.c
-
gio/gdbusconnection.c
-
gio/gdbusconnection.h
-
gio/gdbusdaemon.c
-
gio/gdbuserror.c
-
gio/gdbuserror.h
-
gio/gdbusinterface.c
-
gio/gdbusinterface.h
-
gio/gdbusinterfaceskeleton.c
-
gio/gdbusinterfaceskeleton.h
-
gio/gdbusintrospection.c
-
gio/gdbusintrospection.h
-
gio/gdbusmenumodel.c
-
gio/gdbusmessage.c
-
gio/gdbusmethodinvocation.c
-
gio/gdbusmethodinvocation.h
-
gio/gdbusnameowning.c
-
gio/gdbusnameowning.h
-
gio/gdbusnamewatching.c
-
gio/gdbusnamewatching.h
-
gio/gdbusobject.c
-
gio/gdbusobject.h
-
gio/gdbusobjectmanager.c
-
gio/gdbusobjectmanager.h
-
gio/gdbusobjectmanagerclient.c
-
gio/gdbusobjectmanagerclient.h
-
gio/gdbusobjectmanagerserver.c
-
gio/gdbusobjectmanagerserver.h
-
gio/gdbusobjectproxy.c
-
gio/gdbusobjectproxy.h
-
gio/gdbusobjectskeleton.c
-
gio/gdbusobjectskeleton.h
-
gio/gdbusprivate.c
-
gio/gdbusproxy.c
-
gio/gdbusproxy.h
-
gio/gdbusserver.c
-
gio/gdbusutils.c
-
gio/gdebugcontroller.c
-
gio/gdebugcontroller.h
-
gio/gdebugcontrollerdbus.c
-
gio/gdebugcontrollerdbus.h
-
gio/gdesktopappinfo.c
: !4113 (merged), !4167 (merged) -
gio/gdesktopappinfo.h
-
gio/gdrive.c
-
gio/gdrive.h
-
gio/gdtlsclientconnection.c
-
gio/gdtlsclientconnection.h
-
gio/gdtlsconnection.c
-
gio/gdtlsconnection.h
-
gio/gdtlsserverconnection.c
-
gio/gdtlsserverconnection.h
-
gio/gemblem.c
-
gio/gemblemedicon.c
-
gio/gfile.c
-
gio/gfile.h
-
gio/gfileattribute.c
-
gio/gfileattribute.h
-
gio/gfiledescriptorbased.c
-
gio/gfiledescriptorbased.h
-
gio/gfileenumerator.c
-
gio/gfileicon.c
-
gio/gfileinfo.c
-
gio/gfileinfo.h
-
gio/gfileinputstream.c
-
gio/gfileiostream.c
-
gio/gfilemonitor.c
-
gio/gfilenamecompleter.c
-
gio/gfileoutputstream.c
-
gio/gfilterinputstream.c
-
gio/gfilteroutputstream.c
: !4145 (merged) -
gio/gicon.c
-
gio/gicon.h
-
gio/ginetaddress.c
-
gio/ginetaddressmask.c
-
gio/ginetsocketaddress.c
-
gio/ginitable.c
-
gio/ginitable.h
-
gio/ginputstream.c
-
gio/gioenums.h
-
gio/gioerror.c
-
gio/gioerror.h
-
gio/giomodule-priv.c
-
gio/giomodule.c
-
gio/giomodule.h
-
gio/gioscheduler.c
-
gio/giostream.c
-
gio/giotypes.h
-
gio/giowin32-private.c
-
gio/gkeyfilesettingsbackend.c
-
gio/glistmodel.c
-
gio/gliststore.c
-
gio/gloadableicon.c
-
gio/gloadableicon.h
-
gio/glocalvfs.c
-
gio/gmemoryinputstream.c
-
gio/gmemorymonitor.c
-
gio/gmemorymonitor.h
-
gio/gmemoryoutputstream.c
-
gio/gmemoryoutputstream.h
-
gio/gmemorysettingsbackend.c
-
gio/gmenu.c
-
gio/gmenuexporter.c
-
gio/gmenuexporter.h
-
gio/gmenumodel.c
-
gio/gmenumodel.h
-
gio/gmount.c
-
gio/gmount.h
-
gio/gmountoperation.c
-
gio/gmountoperation.h
-
gio/gnativesocketaddress.c
-
gio/gnetworkaddress.c
-
gio/gnetworking.c
-
gio/gnetworkmonitor.c
-
gio/gnetworkmonitor.h
-
gio/gnetworkmonitorbase.c
-
gio/gnetworkservice.c
-
gio/gnotification.c
-
gio/gnullsettingsbackend.c
-
gio/gosxappinfo.m
-
gio/goutputstream.c
-
gio/gpermission.c
-
gio/gpollableinputstream.c
-
gio/gpollableinputstream.h
-
gio/gpollableoutputstream.c
-
gio/gpollableoutputstream.h
-
gio/gpollableutils.c
-
gio/gpollfilemonitor.c
-
gio/gpowerprofilemonitor.c
-
gio/gpowerprofilemonitor.h
-
gio/gpropertyaction.c
-
gio/gproxy.c
-
gio/gproxy.h
-
gio/gproxyaddress.c
-
gio/gproxyaddressenumerator.c
-
gio/gproxyaddressenumerator.h
-
gio/gproxyresolver.c
-
gio/gproxyresolver.h
-
gio/gregistrysettingsbackend.c
-
gio/gremoteactiongroup.c
-
gio/gresolver.c
-
gio/gresolver.h
-
gio/gresource.c
: !4243 -
gio/gresource.h
-
gio/gseekable.c
-
gio/gseekable.h
-
gio/gsettings.c
-
gio/gsettings.h
-
gio/gsettingsbackend.c
-
gio/gsettingsbackend.h
-
gio/gsettingsschema.c
-
gio/gsimpleaction.c
-
gio/gsimpleactiongroup.c
-
gio/gsimpleasyncresult.c
-
gio/gsimpleiostream.c
-
gio/gsimplepermission.c
-
gio/gsimpleproxyresolver.c
-
gio/gsocket.c
-
gio/gsocketaddress.c
-
gio/gsocketaddressenumerator.c
-
gio/gsocketaddressenumerator.h
-
gio/gsocketclient.c
-
gio/gsocketconnectable.c
-
gio/gsocketconnectable.h
-
gio/gsocketconnection.c
-
gio/gsocketcontrolmessage.c
-
gio/gsocketcontrolmessage.h
-
gio/gsocketlistener.c
-
gio/gsocketlistener.h
-
gio/gsocketservice.c
-
gio/gsocketservice.h
-
gio/gsrvtarget.c
-
gio/gsubprocess.c
-
gio/gsubprocess.h
-
gio/gsubprocesslauncher.c
-
gio/gtask.c
-
gio/gtcpconnection.c
-
gio/gtcpwrapperconnection.c
-
gio/gtestdbus.c
-
gio/gthemedicon.c
-
gio/gthreadedresolver.h
-
gio/gthreadedsocketservice.c
-
gio/gtlsbackend.c
-
gio/gtlsbackend.h
-
gio/gtlscertificate.c
-
gio/gtlsclientconnection.c
-
gio/gtlsclientconnection.h
-
gio/gtlsconnection.c
-
gio/gtlsconnection.h
-
gio/gtlsdatabase.c
-
gio/gtlsfiledatabase.c
-
gio/gtlsfiledatabase.h
-
gio/gtlsinteraction.c
-
gio/gtlspassword.c
-
gio/gtlspassword.h
-
gio/gtlsserverconnection.c
-
gio/gtlsserverconnection.h
-
gio/gunionvolumemonitor.c
-
gio/gunixconnection.c
-
gio/gunixcredentialsmessage.c
-
gio/gunixcredentialsmessage.h
-
gio/gunixfdlist.c
-
gio/gunixfdmessage.c
-
gio/gunixinputstream.c
-
gio/gunixmounts.c
-
gio/gunixmounts.h
-
gio/gunixoutputstream.c
-
gio/gunixsocketaddress.c
-
gio/gunixvolumemonitor.h
-
gio/gvfs.c
-
gio/gvfs.h
-
gio/gvolume.c
-
gio/gvolume.h
-
gio/gvolumemonitor.c
-
gio/gvolumemonitor.h
-
gio/gwin32api-application-activation-manager.h
-
gio/gwin32api-iterator.h
-
gio/gwin32api-package.h
-
gio/gwin32api-storage.h
-
gio/gwin32file-sync-stream.c
-
gio/gwin32inputstream.c
-
gio/gwin32mount.c
-
gio/gwin32outputstream.c
-
gio/gwin32registrykey.c
-
gio/gwin32registrykey.h
-
gio/gwin32sid.c
-
gio/gwin32volumemonitor.c
-
gio/gwin32volumemonitor.h
-
gio/gzlibcompressor.c
-
gio/gzlibdecompressor.c
-
gio/inotify/inotify-helper.c
-
gio/kqueue/dep-list.c
-
gio/kqueue/dep-list.h
-
gio/kqueue/gkqueuefilemonitor.c
-
gio/kqueue/kqueue-helper.c
-
gio/kqueue/kqueue-helper.h
-
gio/kqueue/kqueue-missing.c
-
gio/tests/file.c
-
gio/tests/gdbus-threading.c
-
gio/tests/proxy-test.c
-
gio/tests/test-io-stream.c
-
gio/tests/test-pipe-unix.c
-
gio/win32/gwinhttpvfs.c
-
girepository/gdump.c
— done as part of #3155 (closed) -
girepository/giarginfo.c
— done as part of #3155 (closed) -
girepository/giarginfo.h
— done as part of #3155 (closed) -
girepository/gibaseinfo.c
— done as part of #3155 (closed) -
girepository/gibaseinfo.h
— done as part of #3155 (closed) -
girepository/giboxedinfo.c
— done as part of #3155 (closed) -
girepository/giboxedinfo.h
— done as part of #3155 (closed) -
girepository/gicallableinfo.c
— done as part of #3155 (closed) -
girepository/gicallableinfo.h
— done as part of #3155 (closed) -
girepository/gicallbackinfo.c
— done as part of #3155 (closed) -
girepository/gicallbackinfo.h
— done as part of #3155 (closed) -
girepository/giconstantinfo.c
— done as part of #3155 (closed) -
girepository/giconstantinfo.h
— done as part of #3155 (closed) -
girepository/gienuminfo.c
— done as part of #3155 (closed) -
girepository/gienuminfo.h
— done as part of #3155 (closed) -
girepository/gifieldinfo.c
— done as part of #3155 (closed) -
girepository/gifieldinfo.h
— done as part of #3155 (closed) -
girepository/giflagsinfo.c
— done as part of #3155 (closed) -
girepository/giflagsinfo.h
— done as part of #3155 (closed) -
girepository/gifunctioninfo.c
— done as part of #3155 (closed) -
girepository/gifunctioninfo.h
— done as part of #3155 (closed) -
girepository/giinterfaceinfo.c
— done as part of #3155 (closed) -
girepository/giinterfaceinfo.h
— done as part of #3155 (closed) -
girepository/ginvoke.c
— done as part of #3155 (closed) -
girepository/giobjectinfo.c
— done as part of #3155 (closed) -
girepository/giobjectinfo.h
— done as part of #3155 (closed) -
girepository/gipropertyinfo.c
— done as part of #3155 (closed) -
girepository/gipropertyinfo.h
— done as part of #3155 (closed) -
girepository/giregisteredtypeinfo.c
— done as part of #3155 (closed) -
girepository/giregisteredtypeinfo.h
— done as part of #3155 (closed) -
girepository/girepository.c
— done as part of #3155 (closed) -
girepository/girepository.h
— done as part of #3155 (closed) -
girepository/girffi.c
— done as part of #3155 (closed) -
girepository/girffi.h
— done as part of #3155 (closed) -
girepository/girmodule.c
— done as part of #3155 (closed) -
girepository/girnode-private.h
— done as part of #3155 (closed) -
girepository/girparser.c
— done as part of #3155 (closed) -
girepository/girwriter.c
— done as part of #3155 (closed) -
girepository/gisignalinfo.c
— done as part of #3155 (closed) -
girepository/gisignalinfo.h
— done as part of #3155 (closed) -
girepository/gistructinfo.c
— done as part of #3155 (closed) -
girepository/gistructinfo.h
— done as part of #3155 (closed) -
girepository/gitypeinfo.c
— done as part of #3155 (closed) -
girepository/gitypeinfo.h
— done as part of #3155 (closed) -
girepository/gitypelib-internal.h
— done as part of #3155 (closed) -
girepository/gitypelib.c
— done as part of #3155 (closed) -
girepository/gitypes.h
— done as part of #3155 (closed) -
girepository/giunioninfo.c
— done as part of #3155 (closed) -
girepository/giunioninfo.h
— done as part of #3155 (closed) -
girepository/giunresolvedinfo.c
— done as part of #3155 (closed) -
girepository/giunresolvedinfo.h
— done as part of #3155 (closed) -
girepository/givalueinfo.c
— done as part of #3155 (closed) -
girepository/givalueinfo.h
— done as part of #3155 (closed) -
girepository/givfuncinfo.c
— done as part of #3155 (closed) -
girepository/givfuncinfo.h
— done as part of #3155 (closed) -
glib/deprecated/gcache.c
-
glib/deprecated/gcompletion.c
-
glib/deprecated/gmain.h
-
glib/deprecated/grel.c
-
glib/deprecated/gthread-deprecated.c
-
glib/docs.c
-
glib/galloca.h
-
glib/garcbox.c
-
glib/garray.c
-
glib/gasyncqueue.c
-
glib/gatomic.c
-
glib/gbacktrace.c
-
glib/gbacktrace.h
-
glib/gbase64.c
-
glib/gbitlock.c
-
glib/gbookmarkfile.c
-
glib/gbookmarkfile.h
-
glib/gbytes.c
-
glib/gcharset.c
-
glib/gchecksum.c
-
glib/gchecksum.h
-
glib/gconvert.c
-
glib/gconvert.h
-
glib/gdataset.c
-
glib/gdataset.h
-
glib/gdate.c
-
glib/gdatetime-private.c
-
glib/gdatetime-private.h
-
glib/gdatetime.c
-
glib/gdatetime.h
-
glib/gdir.c
-
glib/genviron.c
-
glib/gerror.c
-
glib/gerror.h
-
glib/gfileutils.c
-
glib/gfileutils.h
-
glib/ggettext.c
-
glib/ghash.c
-
glib/ghmac.c
-
glib/ghook.c
-
glib/ghostutils.c
-
glib/giochannel.c
-
glib/giounix.c
-
glib/giowin32.c
-
glib/gkeyfile.c
-
glib/glib-init.c
-
glib/glib-private.c
-
glib/glib-private.h
-
glib/glib-unix.c
-
glib/glib-unix.h
-
glib/glist.c
-
glib/gmacros.h
-
glib/gmain.c
: partially(?) done in !4177 (merged) -
glib/gmain.h
-
glib/gmappedfile.c
-
glib/gmarkup.c
-
glib/gmarkup.h
-
glib/gmem.c
-
glib/gmem.h
-
glib/gmessages.c
-
glib/gmessages.h
-
glib/gnode.c
-
glib/gnode.h
-
glib/goption.c
-
glib/goption.h
-
glib/gpathbuf.c
-
glib/gpathbuf.h
-
glib/gpattern.c
: !4081 (merged) -
glib/gpoll.c
-
glib/gpoll.h
-
glib/gprimes.c
-
glib/gprintf.c
-
glib/gqsort.c
-
glib/gquark.c
-
glib/gqueue.c
-
glib/gqueue.h
-
glib/grand.c
-
glib/grcbox.c
-
glib/grefcount.c
-
glib/grefcount.h
-
glib/grefstring.c
-
glib/grefstring.h
-
glib/gregex.c
-
glib/gregex.h
-
glib/gscanner.c
-
glib/gsequence.c
-
glib/gshell.c
-
glib/gslice.c
-
glib/gslist.c
-
glib/gspawn-win32.c
-
glib/gspawn.c
-
glib/gspawn.h
-
glib/gstdio.c
-
glib/gstrfuncs.c
-
glib/gstrfuncs.h
-
glib/gstring.c
-
glib/gstringchunk.c
-
glib/gstrvbuilder.c
-
glib/gtestutils.c
-
glib/gtestutils.h
-
glib/gthread-posix.c
-
glib/gthread.c
-
glib/gthread.h
-
glib/gthreadpool.c
-
glib/gtimer.c
-
glib/gtimezone.c
-
glib/gtimezone.h
-
glib/gtranslit.c
-
glib/gtrashstack.c
-
glib/gtree.c
-
glib/gtree.h
-
glib/gtypes.h
-
glib/gunibreak.c
-
glib/gunicode.h
-
glib/gunicollate.c
-
glib/gunidecomp.c
-
glib/guniprop.c
-
glib/guri.c
-
glib/guri.h
-
glib/gutf8.c
-
glib/gutils.c
-
glib/gutils.h
-
glib/guuid.c
-
glib/gvariant-core.c
-
glib/gvariant-parser.c
-
glib/gvariant-serialiser.c
-
glib/gvariant.c
-
glib/gvariant.h
-
glib/gvarianttype.c
-
glib/gvarianttype.h
-
glib/gversion.c
-
glib/gversionmacros.h.in
-
glib/gwin32.c
-
glib/gwin32.h
-
glib/tests/constructor-helper.c
-
glib/tests/spawn-test.c
-
glib/tests/strfuncs.c
-
glib/tests/unicode.c
-
gmodule/gmodule.c
-
gmodule/gmodule.h
-
gobject/gbinding.c
-
gobject/gbinding.h
-
gobject/gbindinggroup.c
-
gobject/gboxed.c
-
gobject/gboxed.h
-
gobject/gclosure.c
-
gobject/gclosure.h
-
gobject/genums.c
-
gobject/genums.h
-
gobject/glib-types.h
-
gobject/gmarshal.c
-
gobject/gmarshal.h
-
gobject/gobject.c
-
gobject/gobject.h
-
gobject/gparam.c
-
gobject/gparam.h
-
gobject/gparamspecs.c
-
gobject/gparamspecs.h
-
gobject/gsignal.c
-
gobject/gsignal.h
-
gobject/gsignalgroup.c
-
gobject/gsourceclosure.c
-
gobject/gtype-private.h
-
gobject/gtype.c
-
gobject/gtype.h
-
gobject/gtypemodule.c
-
gobject/gtypemodule.h
-
gobject/gtypeplugin.c
-
gobject/gtypeplugin.h
-
gobject/gvalue.c
-
gobject/gvalue.h
-
gobject/gvaluearray.c
-
gobject/gvaluearray.h
-
gobject/gvaluecollector.h
-
gobject/gvaluetypes.c
-
gobject/gvaluetypes.h
-
gobject/tests/defaultiface.c
-
gobject/tests/performance/performance.c
-
gobject/tests/reference.c
-
gobject/tests/signals.c
-
tools/gen-visibility-macros.py
Edited by Philip Withnall