<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
</head>
<body>
<div>gtk-doc [1] it's just a document generator, you can check how other Xfce projects (Thunar for instance) use it and try to apply to xfwm4, it's a bit tricky to setup it with autotools, but once that is done you just need to configure with --enable-gtk-doc, make will generate the docs in /docs folder.<br></div><div dir="auto"><br></div><div dir="auto">1 - <a href="https://gitlab.gnome.org/GNOME/gtk-doc">https://gitlab.gnome.org/GNOME/gtk-doc</a><br></div><div dir="auto"><br></div><div>Cheers,<br></div><div>Andre Miranda<br></div><div><br></div><div>Oct 25, 2022, 13:44 by lkml@metux.net:<br></div><blockquote class="tutanota_quote" style="border-left: 1px solid #93A3B8; padding-left: 10px; margin-left: 5px;"><div>On 25.10.22 12:49, andre@andreldm.com wrote:<br></div><blockquote><div>Hi Enrico,<br></div><div>Perhaps you can write documentation comments in gtk-doc format and have them automatically published in https://developer.xfce.org/ <https://developer.xfce.org/><br></div></blockquote><div><br></div><div>Interesting idea, I'll have a look at it :)<br></div><div><br></div><div>I've never used it before, so do you happen to have a pointer to some<br></div><div>good quickstart guide ?<br></div><div><br></div><div><br></div><div>--mtx<br></div><blockquote><div><br></div><div>Cheers,<br></div><div>Andre Miranda<br></div><div><br></div><div>Oct 25, 2022, 11:04 by lkml@metux.net:<br></div><div><br></div><div> On 25.10.22 04:34, Kevin Bowen wrote:<br></div><div><br></div><div> Hello Kevin,<br></div><div><br></div><div> Our documentation for xfconf is maintained at<br></div><div> https://docs.xfce.org/xfce/xfconf/start Currently, we are using<br></div><div> docuwiki to publish our docs.<br></div><div><br></div><div><br></div><div> There's a specific reason why I chose to do it in the source code<br></div><div> instead somewhere external: these are things that depend on the current<br></div><div> source version - eg. when new settings are introduced, the doc can be<br></div><div> fixed by the same commit.<br></div><div><br></div><div> I'm a great fan of in-code documentation and extracting things<br></div><div> automatically: you can always get the right docs for the exact code<br></div><div> version you're currently looking at. And, of course, the docs go though<br></div><div> the same review process like the code itself. documentation as code ;-)<br></div><div><br></div><div> With Wiki's this is hard and complicated achieve, while directly in<br></div><div> git it's pretty trivial.<br></div><div><br></div><div> My plan was letting the CI build these docs and put 'em into some public<br></div><div> place, where they can directly be referenced from Wiki, so we never have<br></div><div> to touch these pieces manually anymore. For the major releases, we can<br></div><div> have separate Wiki entry pages, that always point to the autogenerated<br></div><div> docs of the corresponding version.<br></div><div><br></div><div> Note that right now we're talking about deeper technical docs for the<br></div><div> professionals (those who need to touch xfconf directly, instead of<br></div><div> going through the settings UI) - that's not an end user manual.<br></div><div><br></div><div> I've taken a brief look at your MR and it looks like there is<br></div><div> definitely some info there that would be useful to add.<br></div><div><br></div><div><br></div><div> Note that it's still an early draft - lots of entries are yet empty,<br></div><div> I'll first have to check in the code, what these options are really<br></div><div> doing.<br></div><div><br></div><div><br></div><div> --mtx<br></div><div><br></div><div> -- ---<br></div><div> Hinweis: unverschlüsselte E-Mails können leicht abgehört und manipuliert<br></div><div> werden ! Für eine vertrauliche Kommunikation senden Sie bitte ihren<br></div><div> GPG/PGP-Schlüssel zu.<br></div><div> ---<br></div><div> Enrico Weigelt, metux IT consult<br></div><div> Free software and Linux embedded engineering<br></div><div> info@metux.net -- +49-151-27565287<br></div><div> _______________________________________________<br></div><div> Xfce4-dev mailing list<br></div><div> Xfce4-dev@xfce.org<br></div><div> https://mail.xfce.org/mailman/listinfo/xfce4-dev<br></div><div><br></div><div><br></div><div><br></div><div>_______________________________________________<br></div><div>Xfce4-dev mailing list<br></div><div>Xfce4-dev@xfce.org<br></div><div>https://mail.xfce.org/mailman/listinfo/xfce4-dev<br></div></blockquote><div><br></div><div>-- <br></div><div>---<br></div><div>Hinweis: unverschlüsselte E-Mails können leicht abgehört und manipuliert<br></div><div>werden ! Für eine vertrauliche Kommunikation senden Sie bitte ihren<br></div><div>GPG/PGP-Schlüssel zu.<br></div><div>---<br></div><div>Enrico Weigelt, metux IT consult<br></div><div>Free software and Linux embedded engineering<br></div><div>info@metux.net -- +49-151-27565287<br></div></blockquote><div dir="auto"><br></div> </body>
</html>