Все вопросы: [rdoc]

24 вопросов

похожие теги:
18
голосов
2ответов
5006 просмотров

Зачем нужен синтаксис ": nodoc:"?

Похоже, что многие библиотеки / плагины используют этот синтаксис: def self.included(base) # :nodoc: base.extend ClassMethods end Зачем нужна деталь :nodoc:?

3
голосов
2ответов
1122 просмотров

Лучший вики-синтаксис для документации в коде Ruby и файлах README проекта

Есть ли какой-либо синтаксис вики, такой как rdoc, markdown, ... рекомендуемый в мире рубинов? Иногда я пишу открытый исходный код и не знаю, какой синтаксис мне следует использовать в документах кода и в файлах README.Что будет полезно для меня, что и почему вы его используете.

3
голосов
2ответов
325 просмотров

Отображение унаследованных методов в rdoc

У меня есть программа, написанная на Ruby, в которой используется несколько уровней наследования.Во всех родительских классах реализованы методы, которые будет использовать объект дочернего класса, но когда я создаю rdoc для своей программы, страница rdoc для дочернего класса показывает только м...

6
голосов
2ответов
3249 просмотров

Как сгенерировать сворачиваемые разделы кода в стиле rdoc?

Я создаю внутреннюю документацию для проекта C ++ с помощью Doxygen. У меня Doxygen включает источник методов и т. Д., Но это затрудняет сканирование страницы. Я бы хотел, чтобы он вел себя как rdoc и скрыл источник в блоке, который по умолчанию свернут. Я думал, что HTML_DYNAMIC_SECTIONS мож...

33
голосов
1ответов
13657 просмотров

Why does my Ruby 'ri' tool not return results in command prompt?

Possible Duplicate: ruby 1.9 ri problem When I try to use Ruby's ri tool in a command prompt window to get help about classes, methods, etc. it seems to always fail. For example if I type: ri Array I get a message saying: Updating class cache with 0 classes... Nothing known about A...

0
голосов
1ответов
261 просмотров

RDoc XML generation

I'm trying to generate a RDoc using the XML format. Here's the command that I'm using: $ rdoc --fmt=xml --opname=api.xml The file is created but no method list is generated. I'm using rdoc (2.4.3). The RDoc template for XML include tags for method displaying. Is it possible?

0
голосов
3ответов
1411 просмотров

Gem Server and Rails RDoc Not Found

I would like to read Rails documentation locally though gem server. I go to http://localhost:8808/ and Rails 2.3.3 gem is in the list of the gems installed, but when I click [rdoc] I get: `/doc_root/rails-2.3.3/rdoc/index.html' not found. I tried to uninstall and reinstall Rails but I got no e...

5
голосов
2ответов
1045 просмотров

How do I create an arbitrary link in YARD documentation?

I'm trying to create some links in my YARD documentation. I can get an HTTP link: # I like {http://stackoverflow.com Stackoverflow} renders as <p>I like <a href="http://stackoverflow.com">Stackoverflow</a></p> But an email link: # You can email the {mailto:[email protected]

13
голосов
9ответов
16367 просмотров

How do I generate RDOC for (all of) Rails?

I can do sudo gem rdoc activerecord --no-ri and sudo gem rdoc actionpack --no-ri both of which give me good docs. But sudo gem rdoc rails --no-ri gives me pretty much nothing, as the Rails gem itself is really just a holder for the others. How can I generate the equivalent of http://ap...

1
голосов
2ответов
987 просмотров

Is there a Ruby documentation tool that allows inclusion of diagrams and images?

I am a big fan of doxygen which I have used for years with various languages. In particular, I appreciate its wiki-like ability to include images and run the Graphviz dot generator to have arbitrary inline diagrams from inline DOT code or external files. RDoc has diagramming support to generate ...

3
голосов
1ответов
682 просмотров

Как я могу заставить rdoc правильно читать аргументы метода из моего расширения c?

все, я использую rdoc для создания документации для моего кода Ruby, который содержит C-расширения, но у меня проблемы с аргументами моего метода. Rdoc неправильно разбирает их имена и вместо этого использует p1, p2 и т. Д. Итак, во-первых, мои расширения на самом деле скомпилированы как C ++...

1
голосов
1ответов
97 просмотров

Можно ли получить записи Rdoc из внешних классов ruby?

Если у меня есть несколько классов в пространстве объектов и список методов, которые также генерируются из пространства объектов, есть ли возможность получить документацию по rdoc для одного метода? Пример: ФАЙЛ: foo.rb # Class rdoc information here class foo # defining bar here, jus...

1
голосов
3ответов
952 просмотров

Запуск сервера гемов в пассажирском

Я запускаю несколько приложений rails / rake в Apache / пассажира и хочу добавить в эти приложения приложение документации, обслуживаемое gem server, чтобы я мог легко назначить ему специальный (под) домен, например docs.example. org, поэтому он легко доступен для всех членов нашей команды, и ни...

2
голосов
1ответов
867 просмотров

Получение RSpec в RDoc

В документе Ioke тесты ISpec включены в документацию, см. ioke.org/dok/index.html Как это можно сделать с помощью Ruby RSpec и RDoc (или SDoc)? Я не могу найти никаких переключателей командной строки или внешних библиотек для этого. Есть идеи (не считая реализации всего этого самостоятельно ;...

4
голосов
3ответов
4075 просмотров

Замена для использования rdoc

Согласно этому сообщению , RDoc :: usage в настоящее время недоступен в Ruby 1.9. Доступны ли хорошие замены? Мне было бы интересно узнать, что доступно из стандартной установки, а также из драгоценных камней.

2
голосов
4ответов
3426 просмотров

Как сделать RDoc Ruby Gem по умолчанию в Mac OS X

Недавно я установил версию RDoc (2.4.3) через драгоценные камни Ruby, чтобы заменить версию, поставляемую с Mac OS X (версия 1.0.1). К сожалению, я все еще могу использовать RDoc 1.0.1, только когда вызываю команду run "rdoc" в командной строке. rdoc -v возвращает: RDoc V1.0.1 - 20041108 ...

4
голосов
4ответов
896 просмотров

Как сгенерировать документацию Ruby с использованием другого шаблона?

Я хочу создать документацию Ruby с помощью hanna . Как это сделать? Или где его скачать, если он вообще есть? Использование rdoc -o ~/doc --inline-source --line-numbers --format=html --template=hanna дает мне документы с отсутствующими методами. Похоже, он не генерирует методы, на...

12
голосов
2ответов
2599 просмотров

Можете ли вы установить документацию для существующих гемов?

Рубинсайд упомянул сообщение в блоге о том, как ускорить установку гема, не устанавливая RI или RDoc. Можно ли установить гем и впоследствии установить документацию, чтобы можно было взламывать в спешке и использовать RTFM на досуге?

2
голосов
1ответов
513 просмотров

Как я могу определить разделы без === Заголовки для RDoc :: usage ()?

Мне нравится создавать справочные страницы, используя вывод --help через help2man и txt2man. Система RDoc Ruby очень удобна, но я не могу настроить RDoc :: usage точно так, как я хочу. Вот пример сценария: #!/usr/bin/env ruby # # === Name # # foobar - Example command for StackOverflow quest...

0
голосов
2ответов
278 просмотров

Использование версии .gemspec в документации / библиотеке / скрипте

Итак, я недавно написал кучу рубиновых драгоценных камней, и мне было бы удобно включить текущую версию (как указано в gemspec) в сгенерированную rdoc документацию для моих библиотек и в OptionParser-сгенерированный --help раздел, используемый моими скриптами (которые я распространяю через gem)....

0
голосов
1ответов
573 просмотров

RDoc ПОСТОЯННЫЕ комментарии?

Есть ли способ отображать постоянные комментарии в RDoc? Я хотел бы прокомментировать константу в моем проекте, но понимаю, что они не отображаются в выводе RDoc. Я проверил документацию, в которой, вероятно, есть комментарии к их константам, но никогда не видел их ( http://www.ruby-doc.org/core...

1
голосов
2ответов
179 просмотров

RDoc: изменить название раздела 'Attributes:' в документации ri-Documentation

Я использую метапрограммирование для создания набора методов в Ruby, например: class EmotionalObject def self.mood( name, *details ) define_method(name) do # ... end end mood :happy, #... mood :sad, #... mood :ebuillent, #... #... end Я знаю, что могу передать ...

3
голосов
2ответов
1361 просмотров

Как вы генерируете rDoc для конкретного плагина с помощью граблей

Хорошо, я пытаюсь сгенерировать rDoc для скрепки, но задача rake задыхается от другого плагина до того, как доберется до него, поэтому об этом не может быть и речи: rake doc:plugins Я мог бы пойти и исправить сломанный плагин, но я занят и ленив, поэтому мне просто нужно создать документы...

45
голосов
2ответов
1700 просмотров

Как добавить существующие комментарии к RDoc в Ruby?

Я хочу отформатировать свои существующие комментарии как «комментарии RDoc», чтобы их можно было просматривать с помощью ri. Какие ресурсы рекомендуются для начала использования RDoc?