lgpl-docs

LGPL授权的Gtk-rs包文档。

结构

每个库的文档来自两个文件

• docs.rs 是手动维护的，其条目优先于 vendor.rs 文件。PR 应通常针对此文件。

• vendor.rs 由 gir 通过对上游文档的简单转换生成，这些文档位于 GIR 定义 中。它作为后备方案，其中的文档针对 C 而不是 Rust 进行了定制。此文件不应手动编辑。

您可以按以下方式生成它

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

Cairo，由于缺少GIR定义，没有 vendor.rs 文件。

格式

文件的格式是Markdown，其中包含HTML样式的额外元数据注释，将每个条目与特定的Rust项相关联。例如，此rustdoc片段

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 {

对应于 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.

许可

LGPL