[gjs: 2/3] doc: Update references to module files in documentation
- From: Philip Chimento <pchimento src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gjs: 2/3] doc: Update references to module files in documentation
- Date: Sun, 2 Feb 2020 08:17:44 +0000 (UTC)
commit 116576b4390f27a73180fa97dc88456d4e6b5a90
Author: Philip Chimento <philip chimento gmail com>
Date: Sun Feb 2 09:07:51 2020 +0100
doc: Update references to module files in documentation
doc/Modules.md | 26 +++++++++++++-------------
doc/Package/Specification.md | 2 +-
installed-tests/js/testGObject.js | 6 +++---
3 files changed, 17 insertions(+), 17 deletions(-)
---
diff --git a/doc/Modules.md b/doc/Modules.md
index 38f8c397..6c906070 100644
--- a/doc/Modules.md
+++ b/doc/Modules.md
@@ -1,6 +1,6 @@
GJS includes some built-in modules, as well as helpers for some core APIs like DBus like Variants. The
headings below are links to the JavaScript source, which are decently documented and informative of usage.
-## [Gio](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/overrides/Gio.js)
+## [Gio](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/core/overrides/Gio.js)
**Import with `const Gio = imports.gi.Gio;`**
@@ -30,7 +30,7 @@ The `Gio` override includes a number of utilities for DBus that will be document
[old-dbus-example]: https://wiki.gnome.org/Gjs/Examples/DBusClient
-## [GLib](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/overrides/GLib.js)
+## [GLib](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/core/overrides/GLib.js)
**Import with `const GLib = imports.gi.GLib;`**
@@ -41,13 +41,13 @@ Mostly GVariant and GBytes compatibility.
* `GLib.Variant.unpack()`: Unpack a variant to a native type
* `GLib.Variant.deep_unpack()`: Deep unpack a variant.
-## [GObject](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/overrides/GObject.js)
+## [GObject](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/core/overrides/GObject.js)
**Import with `const GObject = imports.gi.GObject;`**
Mostly GObject implementation (properties, signals, GType mapping). May be useful as a reference.
-## [Gtk](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/overrides/Gtk.js)
+## [Gtk](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/core/overrides/Gtk.js)
**Import with `const Gtk = imports.gi.Gtk;`**
@@ -91,10 +91,10 @@ drawingArea.connect("draw", (widget, cr) => {
});
```
-[cairo-const]: https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/cairo.js
+[cairo-const]: https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/script/cairo.js
[cairo-func]: https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/cairo-context.cpp#L825
-## [Format](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/format.js)
+## [Format](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/script/format.js)
**Import with `const Format = imports.format;`**
@@ -124,7 +124,7 @@ Gettext.ngettext("I have %d apple", "I have %d apples", num).format(num);
[template-literals]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals
[bug-50920]: https://savannah.gnu.org/bugs/?50920
-## [Gettext](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/gettext.js)
+## [Gettext](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/script/gettext.js)
**Import with `const Gettext = imports.gettext;`**
@@ -132,7 +132,7 @@ Helper functions for gettext. See also [examples/gettext.js][example-gettext] fo
[example-gettext]: https://gitlab.gnome.org/GNOME/gjs/blob/master/examples/gettext.js
-## [jsUnit](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/jsUnit.js)
+## [jsUnit](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/script/jsUnit.js)
**DEPRECATED**
@@ -141,7 +141,7 @@ Deprecated unit test functions. [Jasmine][jasmine-gjs] for GJS should now be pre
[jasmine-gjs]: https://github.com/ptomato/jasmine-gjs
[gjs-tests]: https://gitlab.gnome.org/GNOME/gjs/blob/master/installed-tests/js
-## [`Lang`](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/lang.js)
+## [`Lang`](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/script/lang.js)
**DEPRECATED**
@@ -174,7 +174,7 @@ var MyNewClass = class {
}
```
-## [Mainloop](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/mainloop.js)
+## [Mainloop](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/script/mainloop.js)
**DEPRECATED**
@@ -183,11 +183,11 @@ Mainloop is simply a layer of convenience and backwards-compatibility over some
[c-timeoutaddfull]: https://developer.gnome.org/glib/stable/glib-The-Main-Event-Loop.html#g-timeout-add-full
[gjs-timeoutadd]: http://devdocs.baznga.org/glib20~2.50.0/glib.timeout_add
-## [Package](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/package.js)
+## [Package](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/script/package.js)
Infrastructure and utilities for [standalone applications](Home#standalone-applications).
-## [Signals](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/signals.js)
+## [Signals](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/script/signals.js)
**Import with `const Signals = imports.signals;`**
@@ -274,7 +274,7 @@ The System module offers a number of useful functions and properties for debuggi
[example-application]: https://gitlab.gnome.org/GNOME/gjs/blob/master/examples/gtk-application.js
-## [Tweener](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/tweener/)
+## [Tweener](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/script/tweener/)
**Import with `const Tweener = imports.tweener.tweener;`**
diff --git a/doc/Package/Specification.md b/doc/Package/Specification.md
index 2e8d6228..39c92dd3 100644
--- a/doc/Package/Specification.md
+++ b/doc/Package/Specification.md
@@ -89,7 +89,7 @@ This `main()` function should initialize a GApplication whose id is **${entry-po
## Runtime support
-The following API will be available to applications, through the
[`package.js`](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/package.js) module.
+The following API will be available to applications, through the
[`package.js`](https://gitlab.gnome.org/GNOME/gjs/blob/master/modules/script/package.js) module.
* `window.pkg` (ie `pkg` on the global object) will provide access to the package module
* `pkg.name` and `pkg.version` will return the package name and version, as passed to `pkg.init()`
diff --git a/installed-tests/js/testGObject.js b/installed-tests/js/testGObject.js
index bf56bb17..49bbba31 100644
--- a/installed-tests/js/testGObject.js
+++ b/installed-tests/js/testGObject.js
@@ -1,6 +1,6 @@
-// This is where overrides in modules/overrides/GObject.js are tested, except
-// for the class machinery, interface machinery, and GObject.ParamSpec, which
-// are big enough to get their own files.
+// This is where overrides in modules/core/overrides/GObject.js are tested,
+// except for the class machinery, interface machinery, and GObject.ParamSpec,
+// which are big enough to get their own files.
const {GLib, GObject} = imports.gi;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]