Описание тега rdoc
RDoc - это генератор встроенной документации по умолчанию для Ruby. Rdoc создает структурированную документацию, к которой можно получить доступ через веб-браузер или командную строку, анализируя код и специально отформатированные комментарии. Даже при отсутствии комментариев rdoc будет генерировать документацию, используя структуру программ.
1
ответ
Настройка шаблона RDoc
Как я могу изменить мой шаблон RDoc по умолчанию для моей среды Ge m. Мне бы хотелось, чтобы мой гем-сервер выглядел так: RDoc: http://getcloudkit.com/api/ и я видел этот дизайн, так что это не должно быть так сложно.
30 апр '10 в 12:22
1
ответ
Проблемы с установкой rdoc, irb, bluecloth, хронического на fedora 12
Что означают эти ошибки? [root@localhost config]# gem install bluecloth Building native extensions. This could take a while... ERROR: Error installing bluecloth: ERROR: Failed to build gem native extension. /usr/bin/ruby extconf.rb can't find header…
25 май '10 в 12:36
0
ответов
rdoc делает неправильные ссылки на классы в "основном" файле
Классы связаны автоматически в rdocРазметка не требуется. Например, если я включу текст # You can use ExampleClass to give some examples. ExampleClass связан с файлом ExampleClass.html. Это хорошо работает везде, кроме index.html файл, который включ…
10 янв '18 в 22:58
2
ответа
Где найти шаблон rdoc API Rails
Я пытаюсь подтвердить документацию по rdoc, используя версию 3.5.3. Я не фанат встроенной темы darkfish, поэтому я попытался найти способ заменить ее тем, который используется официальной документацией по Rails API на http://api.rubyonrails.org/, но…
05 май '11 в 18:07
1
ответ
Ссылка на метод с тем же именем в другом классе (Rdoc)
Я документирую какой-то рубиновый код прямо сейчас. У нас есть два класса, у обоих есть метод с именем "host". В одном из этих классов метод нуждается в специальных комментариях. В другом классе я хотел бы сослаться на первый класс, и эта ссылка дол…
15 июн '11 в 22:12
1
ответ
Встроенная строка RubyDocumentor, как в PHP?
В PHP мы можем описать любую переменную и получить правильное автозаполнение в среде IDE, такой как PHPStorm. /** @var MyClass $my */ $my = $this->getMy(); Есть ли способ сделать это в RubyMine с помощью RDoc?
27 июл '18 в 21:07
2
ответа
Как пересобрать rdoc для всех установленных гемов?
У меня есть несколько драгоценных камней, установленных в нескольких местах. Какой трудный / простой способ генерировать / регенерировать: RDOC для всех этих установленных драгоценных камней, все сразу? yardoc для всех этих установленных камней, все…
30 июн '10 в 19:47
5
ответов
ОШИБКА: 'rake/rdoctask' устарела и больше не поддерживается
На ровном месте я начал получать следующее сообщение об ошибке: (in /Users/me/.rvm/gems/ruby-1.9.3-p125@mysql2/gems/rails-0.9.5) rake aborted! ERROR: 'rake/rdoctask' is obsolete and no longer supported. Use 'rdoc/task' (available in RDoc 2.4.2+) ins…
12 мар '13 в 23:27
2
ответа
Использование версии.gemspec в документации / библиотеке / скрипте
Итак, я недавно писал кучу рубиновых самоцветов, и я бы посчитал удобным включить текущую версию (как указано в gemspec) в rdocдокументация для моих библиотек, а также в OptionParser-порожденной --help разделы, используемые моими скриптами (которые …
08 янв '09 в 18:44
0
ответов
Как избежать двойных двоеточий в комментарии RDoc?
У меня есть метод, который выглядит так: ## # Opens a file. # # Raises: # +ArgumentError+:: On invalid encoding. # +Errno::ENOENT+:: On invalid file path. # К сожалению, двойные двоеточия в Errno::ENOENT интерпретируется как двойные двоеточия помече…
26 апр '14 в 13:23
2
ответа
Подсветка синтаксиса кода Ruby в файле RDoc?
Я документирую библиотеку Ruby, которую я пишу. В мой файл README.rdoc я включил пример использования с некоторым демонстрационным кодом Ruby. Однако итоговая документация HTML не показывает код Ruby с подсветкой синтаксиса, а просто как блок кода. …
26 янв '12 в 05:29
0
ответов
Можно ли сгенерировать документацию RDoc из классов Java, предоставляемых через JRuby?
У меня есть существующие классы Java, которые открываются для сценариев Ruby через JRuby, и я хотел бы иметь возможность предоставлять документацию в стиле RDoc разработчикам Ruby, которые будут использовать объекты java. Можно ли сгенерировать доку…
28 апр '11 в 20:31
1
ответ
Как указать, что для драгоценного камня не существует ri/rdoc, чтобы пользователь не получал предупреждение при попытке установки
Сам камень, который я создаю, не имеет никакого встроенного ri / rdoc, поэтому когда пользователи gem install если они получают предупреждения, когда rubygems пытается скомпилировать документы: Successfully installed mygem-0.0.1 1 gem installed Inst…
21 янв '11 в 06:33
3
ответа
Есть ли хорошая и надежная ссылка на правильный синтаксис RDoc?
Я ищу хорошую, надежную ссылку для правильного синтаксиса RDoc. Рекомендации? Я не могу найти ничего, что ясно показывает: Как документировать методы класса и их параметры Как документировать, что делает класс или метод класса.
06 окт '10 в 04:25
2
ответа
Документация по Ruby Yard: как добавить "дословно" (чтобы сгенерировать что-то вроде тега <pre>)
Я хочу, чтобы кусок кода, например хэш, отображался с фиксированной гарнитурой в полученном html. Предположим, это содержимое моего файла: =begin One example of valid hash to this function is: { :name => "Engelbert", :id => 1345 } =end def f h…
24 июл '18 в 10:00
3
ответа
Замена для использования rdoc
Согласно этому посту, RDoc:: Использование в настоящее время недоступно в Ruby 1.9. Есть ли хорошие замены доступны? Мне было бы интересно услышать, что доступно из стандартной установки, а также что доступно из драгоценных камней.
11 май '09 в 06:17
1
ответ
Подавление ри и rdoc
Я хочу запретить загрузку ri и rdoc, пока я устанавливаю новые гемы на свой компьютер с Windows. В Linux мы можем редактировать файл.gemrc. Как это сделать в Windows?
24 окт '13 в 10:51
1
ответ
Двор и ссылки на классы / модули в документе
В настоящее время я переключаюсь с rdoc на ярд для моей документации по программному обеспечению ruby. В моем документе я часто ссылаюсь на некоторые классы / модули из комментариев, например: ## == Provides various utility features ## ## == Feature…
16 сен '10 в 08:55
0
ответов
Полностью замените rdoc на ярд для установки / сервера gem
Есть ли способ полностью заменить rdoc на ярд, даже при установке драгоценного камня? Как сейчас, gem server имеет доступ только к документам, сгенерированным rdoc. В некоторых случаях, таких как FFI-gem, документация пишется с ярдом, пытаясь прочит…
24 янв '13 в 16:34
3
ответа
Где найти хорошую документацию RDoc?
Я использую Ruby on Rails 3.0.7, и я хотел бы документировать свое приложение. Для этого я хотел бы найти "хорошую" документацию по RDoc. Где я могу найти это? То есть, на каком "лучшем" веб-ресурсе можно найти документацию по RDoc?
26 июн '11 в 03:44