Bug 765983 – libnm docs don't mention interfaces implemented

After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.

Bug 765983 - libnm docs don't mention interfaces implemented


Summary:	libnm docs don't mention interfaces implemented


Status:	RESOLVED FIXED

Product:	NetworkManager
Classification:	Platform
Component:	general
Version:	unspecified
Hardware:	Other Linux

Importance:	Normal normal
Target Milestone:	---
Assigned To:	NetworkManager maintainer(s)
QA Contact:	NetworkManager maintainer(s)

URL:
Whiteboard:

Depends on:
Blocks:

Reported:	2016-05-04 12:49 UTC by Bastien Nocera
Modified:	2016-05-07 13:44 UTC

See Also:
GNOME target:	---
GNOME version:	---

Description Bastien Nocera 2016-05-04 12:49:56 UTC

Reading the gtk-doc output for libnm, you can't see whether NMRemoteConnection implements NMConnection. You'd need to read the source code to see that.

Comment 1 Beniamino Galvani 2016-05-04 21:00:16 UTC

It seems that gtk-doc doesn't add the interfaces section if there isn't a documentation header in the source file for the type (because the type is put in the "standard" section); we should add such comment everywhere.

Comment 2 Beniamino Galvani 2016-05-07 13:44:24 UTC

Fixed in master:

https://cgit.freedesktop.org/NetworkManager/NetworkManager/commit/?id=a51a43fc848edec39db33b50e333000c2b4363b2

and nm-1-2:

https://cgit.freedesktop.org/NetworkManager/NetworkManager/commit/?h=nm-1-2&id=ca6205b0cf732d79d7e7ba00111cee211ce4031f