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 676856 - Build reference docs
Build reference docs
Status: RESOLVED FIXED
Product: mutter
Classification: Core
Component: general
unspecified
Other All
: Normal normal
: ---
Assigned To: mutter-maint
mutter-maint
Depends on:
Blocks: 695641
 
 
Reported: 2012-05-26 00:52 UTC by Jasper St. Pierre (not reading bugmail)
Modified: 2013-03-14 23:42 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Build reference docs (6.03 KB, patch)
2012-05-26 00:52 UTC, Jasper St. Pierre (not reading bugmail)
needs-work Details | Review
Build reference docs (6.03 KB, patch)
2013-02-15 18:49 UTC, Tomeu Vizoso
none Details | Review
Escape a few < and > from the API docs (1.56 KB, patch)
2013-02-15 18:49 UTC, Tomeu Vizoso
none Details | Review
Remove meta_display_get_atom and MetaAtom (2.08 KB, patch)
2013-02-15 18:49 UTC, Tomeu Vizoso
none Details | Review
Fix gobs of gtk-doc warnings (56.65 KB, patch)
2013-02-15 18:49 UTC, Tomeu Vizoso
none Details | Review
Ignore private headers when generating API docs (1.86 KB, patch)
2013-02-15 18:49 UTC, Tomeu Vizoso
none Details | Review
docs: Fix cross-reference generation (21.77 KB, patch)
2013-02-18 13:21 UTC, Tomeu Vizoso
none Details | Review
Build reference docs (6.03 KB, patch)
2013-02-20 12:20 UTC, Tomeu Vizoso
committed Details | Review
Escape a few < and > from the API docs (1.56 KB, patch)
2013-02-20 12:20 UTC, Tomeu Vizoso
committed Details | Review
Remove meta_display_get_atom and MetaAtom (2.08 KB, patch)
2013-02-20 12:20 UTC, Tomeu Vizoso
committed Details | Review
Fix gobs of gtk-doc warnings (55.15 KB, patch)
2013-02-20 12:20 UTC, Tomeu Vizoso
committed Details | Review
Ignore private headers when generating API docs (1.86 KB, patch)
2013-02-20 12:20 UTC, Tomeu Vizoso
committed Details | Review
docs: Fix cross-reference generation (21.77 KB, patch)
2013-02-20 12:20 UTC, Tomeu Vizoso
committed Details | Review
Update doc generation because fo recent changes (5.68 KB, patch)
2013-02-20 12:21 UTC, Tomeu Vizoso
committed Details | Review

Description Jasper St. Pierre (not reading bugmail) 2012-05-26 00:52:40 UTC
Now that we've ported mutter's docs to GTK+ doc syntax, why not build them?
Comment 1 Jasper St. Pierre (not reading bugmail) 2012-05-26 00:52:42 UTC
Created attachment 215021 [details] [review]
Build reference docs
Comment 2 Jasper St. Pierre (not reading bugmail) 2012-06-09 03:11:14 UTC
Note that after trying it out, there are still a lot of warnings that need to be fixed, and the API isn't as good as it could be.
Comment 3 Owen Taylor 2012-10-08 20:31:17 UTC
Review of attachment 215021 [details] [review]:

Missing mutter-docs.sgml - doesn't build. What is included looks fine.

> Note that after trying it out: there are still a lot of warnings that need to
> be fixed, and the API isn't as good as it could be.

Lot of warnings need to be fixed - prerequisite for landing this patch is to have warnings clean (do a separate followup docs-cleanup patch)

the API isn't as good as it could be - of course :-) ... not really related to whether it has docs.
Comment 4 Tomeu Vizoso 2013-02-15 18:49:15 UTC
Created attachment 236284 [details] [review]
Build reference docs

Rebased
Comment 5 Tomeu Vizoso 2013-02-15 18:49:26 UTC
Created attachment 236285 [details] [review]
Escape a few < and > from the API docs
Comment 6 Tomeu Vizoso 2013-02-15 18:49:34 UTC
Created attachment 236286 [details] [review]
Remove meta_display_get_atom and MetaAtom

They aren't used and MetaAtom confused gtk-doc because it's defined
with a macro.
Comment 7 Tomeu Vizoso 2013-02-15 18:49:43 UTC
Created attachment 236287 [details] [review]
Fix gobs of gtk-doc warnings
Comment 8 Tomeu Vizoso 2013-02-15 18:49:48 UTC
Created attachment 236288 [details] [review]
Ignore private headers when generating API docs
Comment 9 Tomeu Vizoso 2013-02-15 19:10:39 UTC
Sorry, just realized we still get warnings when fixing cross-references. More to come, but not today.
Comment 10 Tomeu Vizoso 2013-02-18 13:21:20 UTC
Created attachment 236587 [details] [review]
docs: Fix cross-reference generation
Comment 11 Tomeu Vizoso 2013-02-18 13:23:18 UTC
These are the remaining warnings, some caused by references to APIs for which there's no gtk-doc docs and the rest by references to private symbols from the public API docs. Suggestions about how to deal with these are welcome.

./meta-unused.txt:1: warning: 1 unused declarations.They should be added to meta-sections.txt in the appropriate place.
  DOC   Building HTML
Computing chunks...
  DOC   Fixing cross-references
html/meta-MetaCompositor.html:52: warning: no link for: 'XEvent' -> (<span class="type">XEvent</span>).
html/meta-util.html:128: warning: no link for: 'meta-display-open' -> (<code class="function">meta_display_open()</code>).
html/meta-group.html:46: warning: no link for: 'Window' -> (<span class="type">Window</span>).
html/meta-window.html:127: warning: no link for: 'XConfigureEvent' -> (<span class="type">XConfigureEvent</span>).
html/meta-prefs.html:107: warning: no link for: 'XIDeviceEvent' -> (<span class="type">XIDeviceEvent</span>).
html/MetaPlugin.html:68: warning: no link for: 'Cursor' -> (<span class="type">Cursor</span>).
html/meta-compositor-mutter.html:52: warning: no link for: 'XserverRegion' -> (<span class="type">XserverRegion</span>).
html/meta-main.html:68: warning: no link for: 'event-callback' -> (<code class="function">event_callback()</code>).
html/meta-common.html:45: warning: no link for: 'Display' -> (<span class="type">Display</span>).
html/MetaShapedTexture.html:56: warning: no link for: 'Pixmap' -> (<span class="type">Pixmap</span>).
html/meta-screen.html:57: warning: no link for: 'Screen' -> (<span class="type">Screen</span>).
html/meta-screen.html:267: warning: no link for: 'SnStartupSequence' -> (<span class="type">SnStartupSequence</span>).
html/meta-display.html:684: warning: no link for: 'mutter-begin-modal-for-plugin' -> (<code class="function">mutter_begin_modal_for_plugin()</code>).
html/MetaBackgroundActor.html:97: warning: no link for: 'MetaWindowGroup' -> (<span class="type">MetaWindowGroup</span>).
Comment 12 Tomeu Vizoso 2013-02-20 12:20:24 UTC
Created attachment 236919 [details] [review]
Build reference docs
Comment 13 Tomeu Vizoso 2013-02-20 12:20:32 UTC
Created attachment 236920 [details] [review]
Escape a few < and > from the API docs
Comment 14 Tomeu Vizoso 2013-02-20 12:20:38 UTC
Created attachment 236921 [details] [review]
Remove meta_display_get_atom and MetaAtom

They aren't used and MetaAtom confused gtk-doc because it's defined
with a macro.
Comment 15 Tomeu Vizoso 2013-02-20 12:20:44 UTC
Created attachment 236922 [details] [review]
Fix gobs of gtk-doc warnings
Comment 16 Tomeu Vizoso 2013-02-20 12:20:52 UTC
Created attachment 236923 [details] [review]
Ignore private headers when generating API docs
Comment 17 Tomeu Vizoso 2013-02-20 12:20:58 UTC
Created attachment 236924 [details] [review]
docs: Fix cross-reference generation
Comment 18 Tomeu Vizoso 2013-02-20 12:21:04 UTC
Created attachment 236925 [details] [review]
Update doc generation because fo recent changes
Comment 19 Jasper St. Pierre (not reading bugmail) 2013-03-14 23:42:15 UTC
Attachment 236919 [details] pushed as a382698 - Build reference docs
Attachment 236920 [details] pushed as 9281a1c - Escape a few < and > from the API docs
Attachment 236921 [details] pushed as edeac1d - Remove meta_display_get_atom and MetaAtom
Attachment 236922 [details] pushed as e0b698d - Fix gobs of gtk-doc warnings
Attachment 236923 [details] pushed as 2863eba - Ignore private headers when generating API docs
Attachment 236924 [details] pushed as be46869 - docs: Fix cross-reference generation


Thanks. Talking with Owen today, he decided we should update these.