gtk-rs-lgpl-docs-0.1.2 doesn't have any documentation.
lgpl-docs
LGPL-licensed docs for Gtk-rs crates.
Structure
The docs for each library come from two files:
-
docs.rs
is maintained manually, its entries take precedence over thevendor.rs
file. PRs should normally target this file. -
vendor.rs
is generated by gir via simple transformation of the upstream docs found in GIR definitions. It serves as a fallback, the docs in it are tailored for C not Rust. This file should not be hand-edited.
Cairo, which lacks GIR definitions, doesn't have a vendor.rs
file.
Format
The format of the files is Markdown with extra metadata in HTML-like comments, which ties each entry to a specific Rust item. For example, this rustdoc snippet:
corresponds to this entry in gtk/vendor.md
:
<!-- impl Button::fn new -->
Creates a new `Button` widget. To add a child widget to the button,
use `Container::add`.
# Returns
The newly created `Button` widget.
License
LGPL