Вопросы по теме 'rdoc'

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

Как создать сворачиваемые разделы кода в стиле rdoc?
Я создаю внутреннюю документацию для проекта C++, используя Doxygen. Я заставляю Doxygen включать исходный код для методов и т. д., но это затрудняет сканирование страницы. Я бы хотел, чтобы он вел себя как rdoc и скрывал исходный код в свернутом по...
3445 просмотров
schedule 27.07.2023

На сервере gem rdoc не установлен, но есть rdoc в терминале
Когда я загружаю сервер и захожу на страницу, я замечаю, что не было ссылки на RDoc . , и когда я перехожу туда, всплывающее окно говорит, что RDoc не установлен. Но когда я набираю rdoc --help в терминале, приходит ответ. Как добраться до...
2424 просмотров
schedule 21.06.2022

Как использовать директиву `:include:` с помощью RDoc?
Я использую Ruby on Rails 3.0.7 и пишу документацию для своего приложения с помощью RDoc . Поскольку я не нашел в Сети хорошей документации с примерами, я хотел бы знать, как вообще использовать директиву :include: . Можете ли вы привести...
628 просмотров

Генерация RDoc в LaTeX
Можно ли сгенерировать RDoc в формате LaTeX? Я смотрел RDoc и YARD, но не нашел того, что мне нужно. Я пишу документацию в LaTeX для своего проекта на Ruby, и мне нужен способ легко встроить ссылку на API в качестве приложения или главы в...
494 просмотров
schedule 04.08.2023

ошибка при установке документации RDoc: несовместимое совпадение регулярного выражения кодировки
За последнюю неделю при нескольких операциях по установке или обновлению гемов я получил ошибку, подобную этой: ERROR: While generating documentation for sinatra-1.3.1 ... MESSAGE: error generating...
4377 просмотров
schedule 06.06.2023

Внутренние комментарии с использованием YARD для документации Ruby?
Я нахожусь в процессе переключения rubygem, который я поддерживаю, с RDoc на документацию YARD. Однако в коде есть некоторые критические комментарии, которые должны оставаться только в коде и не должны отображаться в документации. Например: ## #...
1121 просмотров
schedule 30.06.2023

Синтаксис выделяет код Ruby в файле RDoc?
Я документирую библиотеку Ruby, которую пишу. В моем файле README.rdoc я включил пример использования с некоторым демонстрационным кодом Ruby. Однако полученная HTML-документация не показывает код Ruby с подсветкой синтаксиса, а просто блок кода....
1057 просмотров
schedule 28.03.2023

Создание документации Ruby для классов/исходного кода Java
Поскольку я недавно начал использовать JRuby, а точнее создавать приложения Java с использованием кода Ruby, я начал использовать библиотеки Java, такие как LWJGL и Slick. Я знаю, что JRuby меняет имена методов Java на более рубиновую структуру,...
98 просмотров
schedule 23.03.2023

ОШИБКА: 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...
9196 просмотров
schedule 01.09.2022

Как сделать ссылку rdoc на метод со знаком равенства
В одном файле у меня module Adapter ## # :method: avatar ## # :method: avatar=(value) end В другом файле я хочу иметь ссылки на эти методы: # Adapter#avatar # this generates a valid link to another page # Adapter#avatar=...
282 просмотров

Почему я получаю конфликтующий chdir во время другого блока chdir при обновлении Rubygems на Mountain Lion?
Есть ли способ вернуться к версии RubyGems, которая поставляется с Mountain Lion? Причина, по которой я спрашиваю, заключается в том, что при установке каждого драгоценного камня я получаю следующие предупреждения:...
10008 просмотров
schedule 29.10.2022

Как читать rdoc в Emacs
Сейчас я использую для чтения команду RDoc gem server . Но я хочу прочитать документ в Emacs. Я нашел для него emacs lisp под названием [yari][1] , но он не работает в моей среде. Я вызвал функцию yari и набрал в минибуфере yari: Array , но...
641 просмотров
schedule 25.09.2022

установка пакета завершается сбоем из-за внутренней ошибки сервера rdoc
при попытке установить приложение Ruby с помощью Bundler зависимый гем rdoc завершается с ошибкой Internal Server Error : user@machine:/home/user/someapp# bundle Fetching gem metadata from http://rubygems.org/........... Fetching gem metadata...
268 просмотров
schedule 12.04.2022

Rdoc, YARD и irb, используя внутренний метод для массива?
Я просто пытался создать документацию для своего драгоценного камня, и при запуске rdoc или yard я получил ошибку undefined method `intern' for []:Array Что здесь происходит? Я пытаюсь переустановить все, и у меня рубин 2.3.1. Кроме того,...
134 просмотров
schedule 24.08.2022

Как отображать номера строк в rdoc?
Как заставить rdoc отображать номера строк? Я знаю, что есть переключатель -N , но даже с ним я получаю только # File config.rb, line 40 def port @conf[:port].to_a || DEFAULT_PORT end Я хотел бы иметь номер строки перед каждой строкой,...
83 просмотров
schedule 07.10.2022

Rdoc: Как документировать делегирование?
Мой класс делегирует метод другому объекту (который я назову вспомогательным объектом). Я хочу включить документацию по этому методу в делегирующий класс, а не только в делегированный класс. Программист не должен использовать вспомогательный объект,...
62 просмотров
schedule 11.08.2022