Strange (for me) warnings during doc generating

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Strange (for me) warnings during doc generating

Gergely Polonkai
Hello,

when genering docs for my project (https://github.com/gergelypolonkai/matrix-glib-sdk), I get some strange warnings (line numbers refer to the commit 8d95dd913cbc3fff4475b85a123bed636cc87739 which I conveniently tagged with the gtk-doc-questions tag):

    html/matrix-glib-sdk-MatrixAPI.html:1279: warning: no link for: "MatrixAPI--token" -> (<span class="type">“token”</span>).

This one is referring to a property of an interface which is documented at matrix-api.c:2132.  The property also isn’t listed in the generated HTML documents.

    html/matrix-glib-sdk-MatrixClient.html:332: warning: no link for: "MatrixClient-login-finished" -> (<span class="type">“login-finished”</span>).
    html/matrix-glib-sdk-MatrixClient.html:505: warning: no link for: "MatrixClient-event" -> (<span class="type">“event”</span>).

The above lines refer to signals of an interface and are documented at matrix-client.c:375 and matrix-client.c:394, respectively.  The signals also aren’t listed in the generated HTML documents.

    html/matrix-glib-sdk-MatrixMessageBase.html:379: warning: no link for: "MatrixMessageBase--json" -> (<span class="type">“json”</span>).

This one a property of an abstract class, and is documented at matrix-message-base.c:561.  Again, the property also doesn’t show up in the HTML documents.

    html/matrix-glib-sdk-MatrixRoom.html:875: warning: no link for: "MatrixRoom--default-state-level" -> (<span class="type">“default-state-level”</span>).
    html/matrix-glib-sdk-MatrixRoom.html:875: warning: no link for: "MatrixRoom--default-event-level" -> (<span class="type">“default-event-level”</span>).

These are properties of a regular GObject class (directly derived from GObject), and are documented at matrix-room.c:1474 and matrix-room.c:1487, respectively.  They also don’t show up in the generated HTML documents.

For the record, all of these interfaces/classes are assigned to a section, listed in matrix-glib-sdk-sections.txt, and their generated XML files are included in the main document (matrix-glib-sdk-docs.xml).  The warnings are also present if I start from a clean slate, ie. remove all the files except matrix-glib-sdk-sections.txt and matrix-glib-sdk-docs.xml.

Can anyone help me how can I get rid of these warnings?

Best,
Gergely

_______________________________________________
gtk-doc-list mailing list
[hidden email]
https://mail.gnome.org/mailman/listinfo/gtk-doc-list
Reply | Threaded
Open this post in threaded view
|

Re: Strange (for me) warnings during doc generating

Stefan Sauer-4
On 03/14/2018 10:38 AM, Gergely Polonkai wrote:
Hello,

when genering docs for my project (https://github.com/gergelypolonkai/matrix-glib-sdk), I get some strange warnings (line numbers refer to the commit 8d95dd913cbc3fff4475b85a123bed636cc87739 which I conveniently tagged with the gtk-doc-questions tag):

    html/matrix-glib-sdk-MatrixAPI.html:1279: warning: no link for: "MatrixAPI--token" -> (<span class="type">“token”</span>).

This one is referring to a property of an interface which is documented at matrix-api.c:2132.  The property also isn’t listed in the generated HTML documents.

As much as I'd like to help - since this is vala, it would be nice to put the c files somewhere so that I can see whats going on. In general the " no link for: " warnings are meant to catch typos. In your case it looks like the documents link ro properties and signals, but the docs are maybe not setup correctly to recognize gobjects, in which case you are missing the gobject specific docs. I cannot fidn the gtkdoc setup in git to verify.

Stefan


    html/matrix-glib-sdk-MatrixClient.html:332: warning: no link for: "MatrixClient-login-finished" -> (<span class="type">“login-finished”</span>).
    html/matrix-glib-sdk-MatrixClient.html:505: warning: no link for: "MatrixClient-event" -> (<span class="type">“event”</span>).

The above lines refer to signals of an interface and are documented at matrix-client.c:375 and matrix-client.c:394, respectively.  The signals also aren’t listed in the generated HTML documents.

    html/matrix-glib-sdk-MatrixMessageBase.html:379: warning: no link for: "MatrixMessageBase--json" -> (<span class="type">“json”</span>).

This one a property of an abstract class, and is documented at matrix-message-base.c:561.  Again, the property also doesn’t show up in the HTML documents.

    html/matrix-glib-sdk-MatrixRoom.html:875: warning: no link for: "MatrixRoom--default-state-level" -> (<span class="type">“default-state-level”</span>).
    html/matrix-glib-sdk-MatrixRoom.html:875: warning: no link for: "MatrixRoom--default-event-level" -> (<span class="type">“default-event-level”</span>).

These are properties of a regular GObject class (directly derived from GObject), and are documented at matrix-room.c:1474 and matrix-room.c:1487, respectively.  They also don’t show up in the generated HTML documents.

For the record, all of these interfaces/classes are assigned to a section, listed in matrix-glib-sdk-sections.txt, and their generated XML files are included in the main document (matrix-glib-sdk-docs.xml).  The warnings are also present if I start from a clean slate, ie. remove all the files except matrix-glib-sdk-sections.txt and matrix-glib-sdk-docs.xml.

Can anyone help me how can I get rid of these warnings?

Best,
Gergely


_______________________________________________
gtk-doc-list mailing list
[hidden email]
https://mail.gnome.org/mailman/listinfo/gtk-doc-list



_______________________________________________
gtk-doc-list mailing list
[hidden email]
https://mail.gnome.org/mailman/listinfo/gtk-doc-list
Reply | Threaded
Open this post in threaded view
|

Re: Strange (for me) warnings during doc generating

Gergely Polonkai
Check out the gtk-doc-questions tag. The library used to be Vala, but I ported it back to C.

I double checked for typos (although it doesnʼt mean there is none), so I doubt thatʼs the problem. Thanks for the tip, anyway!

On Mon, Mar 19, 2018, 21:07 Stefan Sauer <[hidden email]> wrote:
On 03/14/2018 10:38 AM, Gergely Polonkai wrote:
Hello,

when genering docs for my project (https://github.com/gergelypolonkai/matrix-glib-sdk), I get some strange warnings (line numbers refer to the commit 8d95dd913cbc3fff4475b85a123bed636cc87739 which I conveniently tagged with the gtk-doc-questions tag):

    html/matrix-glib-sdk-MatrixAPI.html:1279: warning: no link for: "MatrixAPI--token" -> (<span class="type">“token”</span>).

This one is referring to a property of an interface which is documented at matrix-api.c:2132.  The property also isn’t listed in the generated HTML documents.

As much as I'd like to help - since this is vala, it would be nice to put the c files somewhere so that I can see whats going on. In general the " no link for: " warnings are meant to catch typos. In your case it looks like the documents link ro properties and signals, but the docs are maybe not setup correctly to recognize gobjects, in which case you are missing the gobject specific docs. I cannot fidn the gtkdoc setup in git to verify.

Stefan


    html/matrix-glib-sdk-MatrixClient.html:332: warning: no link for: "MatrixClient-login-finished" -> (<span class="type">“login-finished”</span>).
    html/matrix-glib-sdk-MatrixClient.html:505: warning: no link for: "MatrixClient-event" -> (<span class="type">“event”</span>).

The above lines refer to signals of an interface and are documented at matrix-client.c:375 and matrix-client.c:394, respectively.  The signals also aren’t listed in the generated HTML documents.

    html/matrix-glib-sdk-MatrixMessageBase.html:379: warning: no link for: "MatrixMessageBase--json" -> (<span class="type">“json”</span>).

This one a property of an abstract class, and is documented at matrix-message-base.c:561.  Again, the property also doesn’t show up in the HTML documents.

    html/matrix-glib-sdk-MatrixRoom.html:875: warning: no link for: "MatrixRoom--default-state-level" -> (<span class="type">“default-state-level”</span>).
    html/matrix-glib-sdk-MatrixRoom.html:875: warning: no link for: "MatrixRoom--default-event-level" -> (<span class="type">“default-event-level”</span>).

These are properties of a regular GObject class (directly derived from GObject), and are documented at matrix-room.c:1474 and matrix-room.c:1487, respectively.  They also don’t show up in the generated HTML documents.

For the record, all of these interfaces/classes are assigned to a section, listed in matrix-glib-sdk-sections.txt, and their generated XML files are included in the main document (matrix-glib-sdk-docs.xml).  The warnings are also present if I start from a clean slate, ie. remove all the files except matrix-glib-sdk-sections.txt and matrix-glib-sdk-docs.xml.

Can anyone help me how can I get rid of these warnings?

Best,
Gergely


_______________________________________________
gtk-doc-list mailing list
[hidden email]
https://mail.gnome.org/mailman/listinfo/gtk-doc-list


_______________________________________________
gtk-doc-list mailing list
[hidden email]
https://mail.gnome.org/mailman/listinfo/gtk-doc-list

_______________________________________________
gtk-doc-list mailing list
[hidden email]
https://mail.gnome.org/mailman/listinfo/gtk-doc-list