Описание тега rustdoc

Описание тега Вопросы с тегом
NoneRustdoc - это генератор документации для языка программирования Rust.
1 ответ

Как создать документацию для личных вещей

У меня есть проект с: main.rs module_1/mod.rs module_2/mod.rs module_2/module_3/mod.rs когда я бегу cargo docУ меня есть только документация для main.rs, не для модулей. В моем main.rs Я имею: mod module_1; mod module_2; fn main() { ... } Я пытался …
02 сен '18 в 10:52
1 ответ

Как включить графику / диаграммы ASCII в документацию комментариев исходного кода Rust?

Как использовать Markdown с rustdoc для включения диаграмм или ASCII? Из прочтения руководства можно использовать тройные обратные метки для фрагментов кода. Как включить буквальный неформатированный текст? (Что-то вроде Doxygen's <pre>...<…
11 ноя '16 в 15:00
2 ответа

Как предотвратить добавление зависимостей в документацию `rust doc`?

Я только начал играть с Rust и пытался сгенерировать документы для написанного мной кода. Когда я выпустил cargo docЯ увидел что-то странное. 21:53 $ cargo doc Compiling regex-syntax v0.2.2 Compiling libc v0.2.2 Compiling memchr v0.1.7 Compiling aho…
11 дек '15 в 02:59
1 ответ

Почему не проходит тест ржавчины с небезопасным кодом, но тот же код в интеграционном тесте проходит?

Я пытаюсь написать тест ржавчины для метода под названием insert, Функция тестирования вызывается в последней строке теста, и когда я ее закомментирую, тест проходит нормально. Сообщение об ошибке: $ cargo test Compiling reproduce v0.1.0 (file:///ho…
31 июл '18 в 03:27
1 ответ

Как добавить примеры к документации макросов в rust?

При написании макроса я хотел бы документально оформить его, и это включает в себя примеры.Но когда я пытаюсь сделать это так же, как обычную функцию, я получаю: [E0468]: an `extern crate` loading macros must be at the crate root я бегу cargo test н…
30 дек '17 в 12:29
3 ответа

Как вы документируете аргументы функции?

rustdoc позволяет документировать структурные поля и перечислять варианты, добавляя комментарий к документу над каждой строкой: enum Choices { /// The first choice. First, /// The second choice. Second, } struct Person { /// The person's name. name:…
03 май '15 в 02:34
2 ответа

Неразрешенный импорт в примере документации

У меня проблемы с исправлением ошибки в моем примере документации для моей библиотеки. У меня есть структура файла, как для моего ящика bignum . |-- Cargo.lock |-- Cargo.toml |-- examples | |-- dat | | `-- euler_13.dat | |-- debug.rs | `-- euler_13.…
26 июл '15 в 14:43
2 ответа

Есть ли способ включить функцию Cargo только тогда, когда rustdoc проверяет примеры?

У меня есть следующий кусок в документации к ящику: //! # Examples //! ```rust,no_run //! extern crate stm32f103xx; //! // ... //! ``` Проблема в том, что зависимость от stm32f103xx ящик не является обязательным. Все работает нормально, если я включ…
20 сен '17 в 20:31
2 ответа

Могу ли я перенести части теста документации Rust во внешний файл?

Можно ли при написании тестов документации Rust выводить части кода во внешний файл, чтобы пример был коротким?
18 июл '17 в 11:14
4 ответа

Как сделать ссылку на другие fns/structs/enums/traits в rustdoc?

Я строю библиотеку Rust и хочу придать ей немного блеска. В Dustdoc я иногда хотел бы ссылаться на другие части библиотеки в документах, например fns, traitс или structs. Какой официальный синтаксис для этого?
23 июл '15 в 08:30
1 ответ

Как просмотреть rustdoc для библиотеки, от которой зависит мой проект?

Я хотел бы просмотреть документы по ржавчине для библиотеки, от которой зависит моя программа. Как я могу снять это? Я нашел вопрос с ответом для стандартной библиотеки, но я специально искал зависимости crates.io.
06 июл '15 в 12:23
1 ответ

Как удобно разместить актуальную документацию ящика?

Я недавно опубликовал свой первый ящик на crates.io, и мне интересно, смогу ли я поддерживать его документацию проще. Довольно много документов ящиков размещено на страницах GitHub, поэтому я подумал, что смогу это сделать. Я создал репозиторий user…
07 апр '17 в 18:21
2 ответа

Как поместить строку в документацию, которая игнорируется при тестировании документов?

Как я могу написать строку в код документации, но позволить компилятору игнорировать ее? Я хочу написать /// # Examples /// /// To clone something, do /// /// ``` /// IGNORE_FOR_COMPILATION_BUT_SHOW: let cloned = myValue.clone(); /// # let cloned = …
20 фев '17 в 15:12
2 ответа

Есть ли способ скрыть шаблон макроса из документации?

Начиная с Rust 1.6.0, сгенерированная документация скрывает реализацию каждого шаблона макроса: Есть ли способ скрыть некоторые шаблоны из документов, созданных с помощью Cargo? macro_rules! mc { // hide this entire pattern (@impl, $arg:expr) => …
21 фев '16 в 15:07
2 ответа

Как проверить документацию стандартной библиотеки в автономном режиме?

Я нашел rustdoc команда и я вроде ожидал, что это будет работать как pydoc, К несчастью, rustdoc std::io:stdin не делает то, что хотел бы. Есть ли способ просмотра документации стандартной библиотеки в автономном режиме, либо через командную строку,…
17 дек '16 в 13:34
1 ответ

Как сгенерировать документацию rustdoc для [build-dependencies] в Cargo.toml?

Я работаю над небольшим проектом, который интенсивно использует файл build.rs. Кажется, что cargo doc --all генерирует документацию для [dependencies] но не для [build-dependencies] в Cargo.toml. Как я могу сгенерировать автономную документацию для …
07 авг '18 в 14:34
0 ответов

Получение rustdoc для определенной функции или черты

Можно ли получить фрагмент rustdoc для конкретной функции или признака из библиотеки программирования, написанной на Rust, как это делается в инструментах Javadoc? Есть ли какой-нибудь инструмент для этого?
19 апр '16 в 11:51
2 ответа

Не могу использовать зависимый ящик в тестах документации Rust

Я пытаюсь написать документы для проекта, который я пишу на Rust. Один из документов требует использования regex::Regex, Вот документ, который я пытаюсь написать: /// Return a list of the offsets of the tokens in `s`, as a sequence of `(start, end)`…
19 дек '15 в 15:36
1 ответ

Указывает, какая версия сгенерированных документов для ящика предназначена для

Когда вы генерируете документацию для ящика Rust с помощью Cargo и rustdoc, я не вижу никаких указаний на сгенерированных страницах, для какой версии ящика она предназначена. Например, взгляните на документацию по журналу. Есть ли способ узнать, для…
08 май '15 в 10:11
1 ответ

Документация как тесты в Ruby?

Существует отличный инструмент rustdoc (в настоящее время используется Cargo) для тестирования примеров комментариев к документации в Rust. Rdoc или ярд дают нам что-то похожее в Ruby?
29 май '15 в 14:30