summaryrefslogtreecommitdiff
path: root/giscanner/doctemplates
Commit message (Collapse)AuthorAgeFilesLines
* Sort index files by type.rockon9992018-08-061-7/+50
|
* Only output introspectable methods.rockon9992018-08-066-9/+33
|
* devdocs: Distinguish between versioning notesPhilip Chimento2018-08-061-3/+3
| | | | | | Previously, Since:, Deprecated:, and Stability: annotations were all given the same CSS class. In order to style them differently, we give them different classes.
* devdocs: Mention when a function throws an errorPhilip Chimento2018-08-061-0/+4
| | | | | This uses the "throws" annotation in the generated docs, adding a "Throws exception: Yes" if the annotation is present.
* devdocs: Format in and out parameters correctlyPhilip Chimento2018-08-061-7/+20
| | | | | | | | 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.
* devdocs: Describe aliases more thoroughlyPhilip Chimento2018-08-061-0/+16
| | | | For aliases we add a description of what Javascript type they map to.
* devdocs: Add extra CSS class to default.tmplPhilip Chimento2018-08-062-1/+11
| | | | | | | | 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.
* devdocs: Describe bare functionsPhilip Chimento2018-08-061-0/+2
| | | | | Pages for bare functions (not in a class) were missing descriptions of their arguments and return values.
* devdocs: Format the values of constantsPhilip Chimento2018-08-061-3/+7
| | | | | | | 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.
* devdocs: Add deprecated CSS class where neededPhilip Chimento2018-08-066-20/+38
| | | | | | | | | | 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.
* devdocs: Generate versioning notesPhilip Chimento2018-08-065-6/+34
| | | | | | | 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.
* devdocs: Don't render private fieldsPhilip Chimento2018-08-061-4/+22
| | | | | | | | 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.
* devdocs: Render a summary at the top of each pagePhilip Chimento2018-08-062-0/+157
| | | | | | 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.
* doctool: Output formatter for DevDocsPhilip Chimento2018-08-0614-0/+173
| | | | | | | 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.
* docwriter: Option to select output formatPhilip Chimento2018-05-2545-0/+0
| | | | | | | | | | | 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.
* docwriter/Gjs: include static methods in the enum pageGiovanni Campagna2014-02-261-0/+8
| | | | | Switch enum from a topic to a guide page, and include links to all static methods.
* docwriter/gjs: add support for shadowed function namesGiovanni Campagna2014-02-261-1/+1
| | | | | If a function is shadowed, omit it from the documentation, and if a function shadows, uses the new name.
* doctool/Gjs: some more fixes for structs and unionsGiovanni Campagna2014-02-201-2/+11
| | | | | | | | | | | | | | 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...
* doctool: improve Gjs documentationGiovanni Campagna2014-02-2023-115/+216
| | | | | | | | | | | | | | | - 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
* doctool: Use format_xref to format some links to pagesJasper St. Pierre2013-02-1511-23/+11
| | | | | | 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.
* doctool: Make sure to add "new"Jasper St. Pierre2013-02-151-1/+1
|
* doctool: Don't put curly braces around the construct props if there are noneJasper St. Pierre2013-02-151-2/+6
|
* doctool: Don't link to the namespace from the namespace pageJasper St. Pierre2013-02-151-0/+2
|
* doctool: Rename page_style to page_kindJasper St. Pierre2013-02-154-7/+7
|
* doctool: Remove an extra <p> in the signalsJasper St. Pierre2013-02-152-2/+2
|
* doctool: Remove the ctype from the signal return valueJasper St. Pierre2013-02-142-2/+2
| | | | WTF was this here for?
* doctool: Add an link for signal methodsJasper St. Pierre2013-02-142-2/+2
|
* doctool: Fix Gjs class signatureJasper St. Pierre2013-02-141-7/+4
|
* doctool: Gjs doesn't have extra signal parametersJasper St. Pierre2013-02-141-9/+1
|
* doctool: Fix use of <dl> tag in templatesJasper St. Pierre2013-02-149-63/+104
| | | | This isn't legal Mallard
* docwriter: Define a new formatter method for getting paramsJasper St. Pierre2013-02-117-29/+29
| | | | | | | | 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.
* doctool: Don't use zip(range(L))Jasper St. Pierre2013-02-1110-15/+15
| | | | | Instead, remove it entirely (since we don't need the index) or instead use enumerate().
* doctool: Move signal/vfunc templates to extend function.tmplJasper St. Pierre2013-02-013-23/+5
|
* doctool: Update templates to include the actual instance parameterJasper St. Pierre2013-02-013-48/+19
| | | | Rather than fabricating one with a fake name.
* doctool: Switch to UI v1.0Jasper St. Pierre2013-02-013-10/+10
| | | | This is to shut yelp up about experimental UI and expanded.
* doctool: Initial import of a Gjs language that we supportJasper St. Pierre2013-02-0111-0/+157
| | | | Copy/pasted from Python.
* doctool: Use a base template for all node kinds that make senseJasper St. Pierre2013-02-016-109/+61
|
* doctool: Rename templates to exclude mallard/the languageJasper St. Pierre2013-02-0132-24/+24
| | | | | | | | | 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.
* doctool: Use definition lists instead of tablesJasper St. Pierre2013-02-016-68/+40
|
* doctool: Define a standard order of items for all pagesJasper St. Pierre2013-02-0112-34/+44
|
* doctool: Use a base template for all pagesJasper St. Pierre2013-02-0119-237/+101
|
* doctool: Use a standard title for both links and for page titlesJasper St. Pierre2013-02-0118-18/+18
|
* doctool: Switch to a computed page_style for all page templatesJasper St. Pierre2013-02-0122-30/+20
| | | | | This is a quick cleanup before we inherit from a common template for all pages.
* doc: Put documentation templates into their own directoriesJasper St. Pierre2013-01-0918-0/+585
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.
View Lorry Controller Status