#gtk #docs #file #documentation

gtk-rs-lgpl-docs

LGPL-licensed docs for Gtk-rs crates

18 releases

Uses old Rust 2015

0.1.18 Jul 5, 2020
0.1.15 Dec 15, 2019
0.1.12 Jun 24, 2019
0.1.8 Mar 24, 2019
0.0.1 Mar 15, 2016
Download history 161/week @ 2021-01-13 140/week @ 2021-01-20 119/week @ 2021-01-27 71/week @ 2021-02-03 122/week @ 2021-02-10 156/week @ 2021-02-17 152/week @ 2021-02-24 80/week @ 2021-03-03 185/week @ 2021-03-10 80/week @ 2021-03-17 104/week @ 2021-03-24 131/week @ 2021-03-31 100/week @ 2021-04-07 164/week @ 2021-04-14 141/week @ 2021-04-21 167/week @ 2021-04-28

510 downloads per month
Used in 14 crates (12 directly)

LGPL-2.0

1.5MB
76 lines

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 the vendor.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.

You can generate it as follows:

cd gir
cargo run --release -- -c ../your-repo/Gir.toml -d ../gir-files/ -o ../your-repo/ -m doc

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:

impl Button {
    /// Creates a new `Button` widget. To add a child widget to the button,
    /// use `Container::add`.
    ///
    /// # Returns
    ///
    /// The newly created `Button` widget.
    pub fn new() -> Button {

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

Dependencies