Есть ли способ заставить RDoc не стилизовать слова, которые соответствуют классам или модулям? - PullRequest
0 голосов
/ 29 октября 2019

Я пытаюсь написать документацию для одного из моих классов, используя RDoc, и у меня возникает следующая проблема:

Это мой источник:

module Native
  module Facebook
    # Service, which starts(schedules) Native Facebook Fetching Jobs for users with Facebook platform.
    #
    # *IMPORTANT:* <tt>Native::Facebook::StartFetchingJobs</tt> is intended to be called only from <tt>config/schedule.rb</tt>.
    #
    # For example:
    #   # config/schedule.rb
    #   every :day, at: '7:00 pm' do
    #     runner 'Native::Facebook::StartFetchingJobs.call'
    #   end
    #
    class StartFetchingJobs < Service
      # ...

      def call
        # ...
      end

      # ...
    end
  end
end

Это скриншот сгенерированного документа:

enter image description here

Поскольку Native и Facebook являются модулями, RDoc выделяет слова Native и Facebook в созданном документе (зеленым цветом)текст).

Итак, мой вопрос - есть ли способ заставить RDoc не стилизовать слова, которые соответствуют классам или модулям?

1 Ответ

0 голосов
/ 10 ноября 2019

Все, что вам нужно сделать, это просто поставить имена модулей и классов перед обратной косой чертой.

Так что вместо Native и Facebook используйте \Native и \Facebook.

Документация может быть найдена здесь . В разделе Escaping Text Markup.

...