GNOME Bugzilla – Bug 503852
update API docs
Last modified: 2009-12-04 03:12:11 UTC
.
Created attachment 148948 [details] [review] huge docs patch (only for a quick review) This is a one-file patch of all my documentation work up till today, I made it one single patch because the other option was like 30 attachments that I don't think you'd ever finish loading. It has some minor changes in .h files or .c files to fix coherence between argument names in functions and other minor nitpicks. I plan on committing this soon so it doesn't start diverging awfully from master, comments on wording are appreciated. Diff stat: doc/plan/Makefile | 14 - doc/plan/README | 36 - doc/plan/ephyplan.dtd | 15 - doc/plan/plan.xml | 217 ----- doc/plan/plan2table.xsl | 61 -- doc/reference-howto.txt | 43 +- doc/reference/Makefile.am | 169 +---- doc/reference/epiphany-docs.sgml | 18 +- doc/reference/epiphany-sections.txt | 397 +++------ doc/reference/epiphany.types | 39 +- doc/reference/tmpl/EphyContentPolicy.sgml | 19 - doc/reference/tmpl/EphySingle.sgml | 64 -- doc/reference/tmpl/ephy-embed-factory.sgml | 34 - doc/reference/tmpl/ephy-embed-persist.sgml | 235 ----- doc/reference/tmpl/ephy-embed-single.sgml | 69 -- doc/reference/tmpl/ephy-embed.sgml | 399 --------- doc/reference/tmpl/ephy-extensions-manager.sgml | 37 - doc/reference/tmpl/ephy-glade.sgml | 25 - doc/reference/tmpl/ephy-icon-entry.sgml | 53 -- doc/reference/tmpl/ephy-location-entry.sgml | 217 ----- doc/reference/tmpl/ephy-node-db.sgml | 123 --- doc/reference/tmpl/ephy-password-manager.sgml | 78 -- doc/reference/tmpl/ephy-permission-manager.sgml | 78 -- doc/reference/tmpl/ephy-search-entry.sgml | 49 -- doc/reference/tmpl/ephy-session.sgml | 84 -- doc/reference/tmpl/ephy-shell.sgml | 129 --- doc/reference/tmpl/ephy-spinner.sgml | 58 -- doc/reference/tmpl/ephy-tab.sgml | 202 ----- doc/reference/tmpl/ephy-window.sgml | 110 --- doc/reference/tmpl/ephy-zoom-control.sgml | 56 -- doc/reference/tmpl/epiphany-unused.sgml | 1043 ----------------------- doc/reference/tmpl/mozilla-embed-event.sgml | 35 - embed/ephy-web-view.c | 32 +- embed/ephy-web-view.h | 16 +- lib/ephy-zoom.c | 3 +- lib/widgets/ephy-location-entry.c | 52 +- lib/widgets/ephy-node-view.c | 450 +++++++--- lib/widgets/ephy-node-view.h | 36 +- lib/widgets/ephy-search-entry.c | 18 + lib/widgets/ephy-search-entry.h | 2 +- lib/widgets/ephy-spinner.c | 9 + lib/widgets/ephy-spinner.h | 4 +- lib/widgets/ephy-tree-model-node.c | 59 ++ lib/widgets/ephy-tree-model-node.h | 10 +- lib/widgets/ephy-tree-model-sort.c | 30 + lib/widgets/ephy-tree-model-sort.h | 10 +- lib/widgets/ephy-zoom-action.c | 34 + lib/widgets/ephy-zoom-control.c | 21 +- src/ephy-location-action.c | 88 ++- src/ephy-statusbar.c | 16 +- src/ephy-toolbar.c | 126 +++- src/ephy-toolbar.h | 4 +- src/ephy-window.c | 11 +- src/ephy-window.h | 5 - 54 files changed, 986 insertions(+), 4256 deletions(-)
Comment on attachment 148948 [details] [review] huge docs patch (only for a quick review) obsoleting, i'll attach individual patches, they are much better named.
Created attachment 148959 [details] [review] docs: remove old nonexistant API Bug #503852
Created attachment 148960 [details] [review] docs: ephy-node-view Bug #503852
Created attachment 148961 [details] [review] ephy-web-view: formatting nitpick Bug #503852
Created attachment 148962 [details] [review] docs: ephy-web-view missing @view descriptions Bug #503852
Created attachment 148963 [details] [review] docs: ephy-tree-model-sort Also disable incomplete documentation. Bug #503852
Created attachment 148964 [details] [review] docs: ephy-tree-model-node Bug #503852
Created attachment 148965 [details] [review] docs: ephy-window Also make _ephy_window_set_context_event and _ephy_window_unset_context_event static since noone was using those. Bug #503852
Created attachment 148966 [details] [review] docs: ephy-statusbar Bug #503852
Created attachment 148967 [details] [review] docs: ephy-toolbar Bug #503852
Created attachment 148968 [details] [review] docs: ephy-location-action Bug #503852
Created attachment 148969 [details] [review] docs: nitpick in ephy-web-view Bug #503852
Created attachment 148970 [details] [review] docs: missing parameters in signals Bug #503852
Pushed everything to master, will keep committing documentation addition and fixes. Closing this bug since it makes little sense to leave it open. Attachment 148959 [details] pushed as a10d468 - docs: remove old nonexistant API Attachment 148960 [details] pushed as 4f052b4 - docs: ephy-node-view Attachment 148961 [details] pushed as ec56c8a - ephy-web-view: formatting nitpick Attachment 148962 [details] pushed as c215911 - docs: ephy-web-view missing @view descriptions Attachment 148963 [details] pushed as ac9f536 - docs: ephy-tree-model-sort Attachment 148964 [details] pushed as 57d1e4a - docs: ephy-tree-model-node Attachment 148965 [details] pushed as 86d5198 - docs: ephy-window Attachment 148966 [details] pushed as deac403 - docs: ephy-statusbar Attachment 148967 [details] pushed as b089181 - docs: ephy-toolbar Attachment 148968 [details] pushed as ad91b4e - docs: ephy-location-action Attachment 148969 [details] pushed as 86bb454 - docs: nitpick in ephy-web-view Attachment 148970 [details] pushed as 0fdd13a - docs: missing parameters in signals