Browse Source

Apply suggestions (II)

pull/64/head
TechiePi 2 years ago
parent
commit
1eca556700
  1. 20
      ctru-sys/src/bin/docstring-to-rustdoc.rs

20
ctru-sys/src/bin/docstring-to-rustdoc.rs

@ -2,22 +2,22 @@
//! //!
//! # Usage //! # Usage
//! //!
//! ``cargo run --bin docstring-to-rustdoc -- [location of the bindings.rs]`` //! `cargo run --bin docstring-to-rustdoc -- [location of the bindings.rs]`
//! Example: ``cargo run --bin docstring-to-rustdoc -- src/bindings.rs`` //! Example: `cargo run --bin docstring-to-rustdoc -- src/bindings.rs`
//! //!
//! # Transformations //! # Transformations
//! //!
//! The following are _completely_ removed, but _its contents are kept_: //! The following are _completely_ removed, but _its contents are kept_:
//! * ``@brief`` //! * `@brief`
//! * ``@ref`` //! * `@ref`
//! * ``@note`` //! * `@note`
//! * ``@return`` //! * `@return`
//! * ``@sa`` //! * `@sa`
//! * ``<`` //! * `<`
//! * ``[out]`` and ``[in]`` //! * `[out]` and `[in]`
//! //!
//! The followings are _partially_ transformed to Rustdoc format: //! The followings are _partially_ transformed to Rustdoc format:
//! * ``@param`` //! * `@param`
use std::{env, fs, io}; use std::{env, fs, io};
use std::path::Path; use std::path::Path;

Loading…
Cancel
Save