Adding further modules to api.kde.org

Martin Graesslin mgraesslin at kde.org
Sat Sep 19 18:03:40 BST 2015


On Saturday, September 19, 2015 12:54:57 PM CEST you wrote:
> http://api.kde.org/4.x-api/workspace-apidocs/kwayland/html/index.html
> look ok?

hmm that doesn't use the wonderful README.md. Compare to http://kde.martin-graesslin.com/kwayland/index.html (requires IPV6)

Interestingly whenever I locally generated with kgenapidox it included the 
README.md and I did verify after adding the .dox file that it doesn't change. 
What's used on ebn to generate the docs?

> 
> what would be a better url for this?
> perhaps http://api.kde.org/plasma-apidocs/kwayland/html/index.html ??

My opinion would be workspace is better as that's what our module is still 
called on projects.kde.org. If others think it should be plasma I won't oppose 
;-)

Anyway: thanks for putting it up. Much appreciated!

Cheers
Martin

> 
> On Friday, September 11, 2015 08:10:37 AM Martin Gräßlin wrote:
> > Am 2015-09-10 21:50, schrieb Allen Winter:
> > > On Thursday, September 10, 2015 10:57:10 AM Martin Graesslin wrote:
> > >> Hi all,
> > >> 
> > >> back in KDE4 days the workspace libraries were listed on api.kde.org
> > >> [1]. But
> > >> for the current version we don't have any API docs available. The
> > >> section
> > >> "Other KDE Software" [2] lists KDE Support, KDE Extragear and
> > >> Playground but
> > >> apparently nothing from what used to be KDE SC.
> > >> 
> > >> Does anybody know how I can get our KDE Workspaces listed there again?
> > >> I'm in
> > >> particular interested in getting KWayland API documentation published.
> > >> 
> > >> If nobody knows: does anyone know who needs to be poked.
> > > 
> > > http://api.kde.org/4.x-api/workspace-apidocs/ exists
> > > The KDE SC stuff is shown under "KDE4 Versions"
> > > http://api.kde.org/history4.php
> > > 
> > > I do notice that under the various KDE 4.foo tables we don't have a
> > > workspace entry
> > > we have kde-workspace, but not workspace.  seems like kde-workspace
> > > and workspace are similar.
> > > 
> > > I'm not sure there's anything to fix.
> > 
> > Well it's KDE4, it's old and outdated. It doesn't list new modules like
> > the new KDecoration library or KWayland.
> > 
> > Looking at the documentation it seems like at least KWin's documentation
> > is from latest master - this is rather unexpected to be found under
> > "KDE4".
> > 
> > So yes I think there is lots to fix and I'm willing to look into it.
> > Just I need to be told how.
> > 
> > If I as the maintainer are not able to find the documentation of my own
> > software, nobody else is. Just that should show that there is quite
> > something to fix ;-)
> > 
> > Cheers
> > Martin
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 181 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/kde-core-devel/attachments/20150919/36bace85/attachment.sig>


More information about the kde-core-devel mailing list