| Commit message (Collapse) | Author | Age | Files | Lines |
| |
|
| |
|
|
|
|
|
|
| |
Previously, Since:, Deprecated:, and Stability: annotations were all
given the same CSS class. In order to style them differently, we give them
different classes.
|
|
|
|
|
| |
This uses the "throws" annotation in the generated docs, adding a "Throws
exception: Yes" if the annotation is present.
|
|
|
|
|
|
|
|
| |
Previously the functions template did not properly use
formatter.get_in_parameters() and formatter.get_out_parameters(), so we
had inaccurate function arguments in the documentation. In particular, I
originally didn't take functions with multiple return values into
account.
|
|
|
|
| |
For aliases we add a description of what Javascript type they map to.
|
|
|
|
|
|
|
|
| |
We add an extra CSS class to default.tmpl to indicate what kind of AST
node is represented here (e.g., ast.Constant). This should properly
belong in get_node_kind() in docwriter.py, but adding extra kinds there
would affect the way that all the other documentation output formats are
generated.
|
|
|
|
|
| |
Pages for bare functions (not in a class) were missing descriptions of
their arguments and return values.
|
|
|
|
|
|
|
| |
We change the style of documentation pages for constants, so that their
values are displayed in a <dt>/<dd> pair. We add a new method to the
formatter family, format_value() which should print the representation of
a constant's value in the target language; much like repr() in Python.
|
|
|
|
|
|
|
|
|
|
| |
This adds a def in _doc.tmpl that expands to "deprecated" if the node is
deprecated, and to nothing otherwise. We use it to give the deprecated CSS
class to particular elements. The presence of the class on a symbol's main
entry will inform DevDocs that the symbol is deprecated, though it won't
be formatted in a particular way. The presence of the class on an index
entry will cause the index entry to be struck out, so that it's visually
obvious in the index when a symbol is deprecated.
|
|
|
|
|
|
|
| |
For GIR nodes with version annotations, such as "Since:", "Deprecated:",
and "Stability:", we generate stability notes at the top of each node's
documentation. These notes are given the CSS class "versioning-note" so
that we can format them nicely in DevDocs.
|
|
|
|
|
|
|
|
| |
Skip private fields such as "priv" and "parent_instance". Unfortunately
not all private structure and parent instance fields are marked private,
and not all of them are named "priv" or "parent_instance".
This also includes fields that are contained within anonymous unions.
|
|
|
|
|
|
| |
This summary, heavily inspired by the one from pgi-docs, is useful when
browsing the page rather than searching for a specific term. It's also
similar to the summary at the top of gtk-doc pages.
|
|
|
|
|
|
|
| |
In order to generate HTML output that DevDocs can easily scrape and
display, we add a new output format to g-ir-doc-tool (--format=devdocs).
It works similarly to the Mallard output format, but generates very simple
HTML instead. We add a new set of Mako templates to generate this output.
|
|
|
|
|
|
|
|
|
|
|
| |
For generating other output formats such as DevDocs-ready HTML, we add an
output format option (-f). The default output format is "mallard" which
leaves the existing behaviour unchanged.
We can fold the existing --write-sections-file option into the new output
format option, as a new "sections" format.
Closes #134.
|
|
|
|
|
| |
Switch enum from a topic to a guide page, and include links to
all static methods.
|
|
|
|
|
| |
If a function is shadowed, omit it from the documentation, and
if a function shadows, uses the new name.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Stop pretending we have fields on unions (only methods are
supported).
Add minimal support (ie, don't crash) to nested structures,
that due to how ast works have namespace None (and the
transformers hard-depend on that). Uncovered by GLib's
GDoubleIEEE754, before I removed union fields.
For some reason, RegressTestStructE (anonymous union) has a
completely different behavior and generates a weird name,
while RegressLikeGnomeKeyringSchema (array of unnamed structs)
becomes array(gpointer).
Bah, one should have methods anyway...
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
- Add documentation for structures, fields, constants and
callbacks
- Improve the synopsis for interfaces to have prerequisites
and known implementations
- Respect gjs constraints for field writability
- Format in and out parameters for callables according to GJS
conventions
- Format property names according to the GJS API
- Show boxed constructors according to how they can be used
in the gjs API
https://bugzilla.gnome.org/show_bug.cgi?id=724735
|
|
|
|
|
|
| |
We don't do a full 100% conversion for all link tags, yet,
because I don't want to break too much here. This may come
later.
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
|
|
| |
WTF was this here for?
|
| |
|
| |
|
| |
|
|
|
|
| |
This isn't legal Mallard
|
|
|
|
|
|
|
|
| |
This will let us gracefully skip over parameters that aren't exposed
by specific language bindings.
It also fixes a bug in the C/Python documentation where we weren't
iterating over the right parameters.
|
|
|
|
|
| |
Instead, remove it entirely (since we don't need the index) or instead
use enumerate().
|
| |
|
|
|
|
| |
Rather than fabricating one with a fake name.
|
|
|
|
| |
This is to shut yelp up about experimental UI and expanded.
|
|
|
|
| |
Copy/pasted from Python.
|
| |
|
|
|
|
|
|
|
|
|
| |
As templates are in their own directory and segregated into language
already, this is sort of repeating the issue. At the same time, always
explicitly use relative ("./") or absolute ("/") lookups for templates.
We want to eventually have base templates to share between languages, so
to do so without namespace clashes makes sense.
|
| |
|
| |
|
| |
|
| |
|
|
|
|
|
| |
This is a quick cleanup before we inherit from a common template
for all pages.
|
|
Instead of cluttering up the giscanner directory, put templates
into their own files, with each language having its own templates
in its own directory for comfort.
|