This site has been retired. For up to date information, see handbook.gnome.org or gitlab.gnome.org.


[Home] [TitleIndex] [WordIndex

For updated documentation, please see the GJS repository.

1. Developer documentation for Gjs

Documentation for Gjs, and for the GNOME platform libraries as used in gjs, is hosted in the gjs-documentation module in git.

It is written in mallard and generated through g-ir-doc-tool. The module includes a basic Makefile to build the documentation locally, as well as upload it to people.gnome.org.

The preliminary results of this work are hosted at http://people.gnome.org/~gcampagna/docs/

Additional updated documentation hosted at http://devdocs.baznga.org/

1.1. Why a gjs-documentation git module?

Because we host also documentation for gjs-specific APIs in GLib, GObject and Gio (so called "overrides"). In the future we will host documentation for native gjs APIs (Lang, Mainloop, Signals...)

1.2. Known bugs and limitations


2024-10-23 10:58