methods=
sublibraries=rdoc.markup.simple_markup.to_latex,rdoc.usage,rdoc.markup.simple_markup.to_flow,rdoc.markup.simple_markup.to_html,rdoc.markup.simple_markup
requires=
classes=RDoc,RDoc=RDoc,RDoc=RDocError
is_sublibrary=false

RDoc  Ruby ΥɥԤΥ饤֥Ǥrdoc Ȥ
ɥΤΥޥɤޤǤޤ

Υѥå Rdoc  SimpleMarkup ȤդĤΥݡͥȤ
Ǥޤ Rdoc Ȥ Ruby ΥեФɥȤ
륢ץꥱǤ JavaDoc ƱͤˡϤ饹
塼롢᥽åɤȴФƤޤ(include,require Ǥ)
ƤƤȤľ˽񤫤줿Ȥʻ礷ɥȤ
Ϥޤ(ߤ HTML ϤǤޤ󤬡ʬϼؤǽˤǤ
Ƥޤ)Markup Ȥϥץ졼ƥȤ͡ʥեޥåȤѴ뤿
Υ饤֥ǤRdoc ˤäƥ᥽åɤ䥯饹˴ؤɥȤ
ȤѴ뤿˻Ȥޤ

=== ɥޥå

 * Rdoc  Ruby ΥեФɥȤСޤʸϤɤߤޤ礦
 * Cǽ񤫤줿ĥ饤֥ޤ᤿С[[lib:rdoc/parsers/parse_c]] 򸫤Ƥ
 * ǻȤޡåפˤĤΤꤿС[[lib:rdoc/markup/simple_markup]] 򸫤Ƥ
 * RDoc 饤֥ȤƻȤС[[c:RDoc::RDoc]] 򸫤Ƥ
 * ƥ HTML Ѵʬ饤֥ȤƻȤС[[c:SM::SimpleMarkup]] 򸫤Ƥ
 * ȼ HTML ƥץ졼ȤǽϤС[[c:RDoc::Page]] 򸫤Ƥ

=== 

󥹥ȡ뤹С'rdoc' ޥɤǥɥȤǤޤ
(Windows Ǥ 'rdoc.bat' Ǥ)

  $ rdoc [options]  [names...]

"rdoc --help" ǤƤСǿΥץ˴ؤޤ

  $ rdoc

Υޥɤǥȥǥ쥯ȥʲˤ뤹٤Ƥ Ruby CΥ
ɥȤޤɥȤϥȥǥ쥯ȥ
ľ 'doc' Ȥǥ쥯ȥ֤ޤ

ɥȤɤͤ˼äʤ褦ˡɥȤΥ
ǥåڡ濴Ūʥե˽񤫤ƤƤޤ뤳ȤǤޤ
㤨СRdoc ΤΤΥɥȤϡʲΤ褦˥
ޤ

  $ rdoc --main rdoc/rdoc.rb

RDoc ɥȤΥǻȤ͡ʥޡåפˡ
ϰʲ [[ref:markup]] ι˽񤫤Ƥޤ

RDocϳĥҤˤäƥեɤ٤ޤե̾
 .rb  .rbw Ǥե Ruby ΥեȤƽ
ޤ .c ǤեCΥȤƽޤʳ
եñʤ SimpleMarkup-style ǵҤ줿եȤƽ
ޤ(ԤƬˡ#פȤȵ椬äƤʤƤƱ褦˽
ޤ)ޤRDoc ˥ǥ쥯ȥ̾ϤȡΥǥ쥯
ƵŪޤξ Ruby  C ΥեΤߤ
ޤ

===[a:usage] Ȥ

RDoc ϥޥɥ饤󤫤ʲΤ褦ˤƵưޤ

  $ rdoc <options> [name...]

եѡ˴ޤޤƤ򽸤ᡢϤޤ
եϤ륯ե󥹤Ǥޤ ⤷ name ǥ쥯
ȥʤСޤ name ꤷʤСȥǥ
ȥ(ȤΥ֥ǥ쥯ȥ)Ƥ Ruby Υեޤ

options ϰʲǤޤ

: --accessor name

  name ǻꤷ᥽åɤ attr_xxx ƱͤʤΤȤƼ갷ޤ㤨
   "--accessor db_opt" ȤȡʲΤ褦ʹԤ RDoc ˤäƽ
  ɥȤ˴ޤޤ褦ˤʤޤ

//emlist{
    db_opt :name, :age
//}

  줾 name ˤ "=flagtext" Ȥץդ뤳ȤǤ
  㤨С"=rw" Ȥ attr_accessor Ʊ褦˼갷ޤ

: --all

  ץƥƥåɥ᥽åɤץ饤١ȥ᥽åɤϤ˴ޤޤ褦
  ʤޤ(ǥեȤǤϥѥ֥å᥽åɤΤߤǤ)

: --charset charset

   HTML  charset ꤷޤ



: --debug

  ¹ԻϤޤ


: --diagram

  ⥸塼䥯饹ɽΤ˿ޤȤ褦ˤʤޤεǽϼ
  ŪʤΤǡ٤Ƥνϥƥץ졼ȤбƤ櫓ǤϤޤ
  dot V1.8.6 ʹߤʤ "--diagram" ץϤ
  Ǥޤ(www.research.att.com/sw/tools/graphviz/)



: --exclude pattern

  pattern ˥ޥåǥ쥯ȥꤪӥեоݤޤ

: --extension new=old

  ե̾ .new ǤΤ .old ǤΤȤƼ
  갷ޤ㤨 '--extension cgi=rb' ȤСRDoc  ".cgi" 
  ե Ruby ΥȤƼ갷ޤ

: --fileboxes

  --diagram ꤷ줿ޤˤơ饹ɤΥե
  Ƥ뤫ͳѤǰϤȤǼޤʣΥե
  Ƥ륯饹ʣλͳѤˤޤäޤޤ--diagram
  Ȥä˻Ȥʤа̣ΤʤץǤ(¸ŪʵǽǤ)

: --force-update

  ϺѤߤΥեǤƤΥե򹹿ޤ
  1.9.2 ʲǤϻꤷʤäͭˤʤޤ1.9.2 ʹߤϻ
  ʤäǤͭˤʤޤ



: --fmt fmt

  Ϥꤷޤ

: --help

  Ȥγפɽޤ

: --help-output

  Ϥ˴ؤ륪ץ⤷ޤ


: --image-format gif/png/jpg/jpeg

  ޤΥեޥåȤꤷޤpnggifjpegjpg Ǥޤ
  ꤷʤä png Ȥޤ--diagram ɬפǤ

: --include dir,

  :include: ̿ǥեõǥ쥯ȥꤷޤ --include 
  ʣȤäƤ⤫ޤޤ󡣤ꤷʤȤΥեϤ
  õޤ

: --inline-source

  ǥեȤǤϡ᥽åɤΥɤϥݥåץåץɥɽ
  ޤΥץդȡ饤ɽޤ

: --line-numbers

  ɤ˹ֹդޤ

: --main name

  ǽɽڡ֤(饹եʤ)ꤷ
  ⤷Υե(㤨СREADME ʤ)֤С
  ޥɥ饤κǽ֤Ǥ⤫ޤޤ

: --merge

  ri νϤȤϥǥ쥯ȥˤǤ˥ե뤬¸ߤС
  Υե񤭤ˡޡ褦ˤޤ

: --one-file

  ٤ƤνϤĤΥե˽񤭤ޤ

: --op dir

  Υǥ쥯ȥ dir ꤷޤ(ǥեȤ "doc" Ǥ)

: --opname name

  Ϥ̾nameˤޤ(HTML Ϥˤϲθ̤⤢ޤ)


: --promiscuous

  饹ե뤬ʣΥեƤơʥӥڥ
  Υեν򥯥å硢Υ⥸塼Υ饹ʤɤ
  ϤΥեƤʬɽޤ󡣤Υץ
  ꤹȡΥեƤ뤫ɤˤ餺
  ƤΥ⥸塼(饹)⥸塼(饹)ɽޤ

: --quiet

  ʹԥåɽޤ

: --ri, --ri-site, and --ri-system

  ri ɤϤޤǥեȤǤ --ri ꤹ
  ~/.rdoc ˽Ϥޤ--ri-site  $datadir/ri/<ver>/site
  ˡ--ri-system  $datadir/ri/<ver>/system ˽Ϥޤ줹
  ٤ƤϤ˻ꤷ --op 񤭤ޤǥեȤΥǥ쥯ȥ
   ri ΥǥեȤΥѥǤ

: --show-hash

   name ȤȤ饤󥹥󥹥᥽åɤؤΥϥѡ
  󥯤ޤΥץꤷʤ '#' ϼ
  

: --style stylesheet url

  (RDoc ΤǤϤʤ)륷Ȥ URL ꤹ롣

: --tab-width n

  ֤ꤹ(ǥեȤ 8)

: --template name

  ˻Ȥƥץ졼Ȥꤹ(ǥեȤ 'standard')
  ݤˤϤ [[m:$:]] Υǥ쥯ȥ
  rdoc/generators/xxxx_template Ȥ롣 (xxxx ϥեޥåˤ
  ưۤʤ)

: --title text

  ϤΥȥ text ˻ꤷޤ



: --version

  RDocΥСɽ롣

: --webcvs url

  CVS Υ֥եȥɤؤΥ󥯤 URL ꤹ롣URL  '\%s'
  ޤǤСե֤̾ޤ'\%s' ޤ
  ʤСե̾ꤷ URL θդΤȤޤ

===[a:markup] Markup

Ϥʤ꼫˽񤯤ȤǤޤ'#' ǻϤޤ륳ȤȤ
ޤ=begin/=end ǤΥȤȤޤ=begin/=end Ȥϡ
ʲΤ褦 =begin ιԤ 'rdoc' դɬפޤ

  =begin rdoc
  Documentation to
  be processed by RDoc.
  =end

ѥ饰դϺΥǥȤ·ƥȤΤޤǹޤ
⿼ǥȤ줿ƥȤϤΤޤޡޡåפθ
˥եޥåȤޤ

ޤRDoc '#--' ޤԤȽ򤷤ʤʤޤǳ
ȤȤʬΥꡢ᥽åɡ饹⥸塼
ȴطʤȤǤޤ'#++' ǻϤޤԤȡ
Ƴޤ

  # Extract the age and calculate the
  # date-of-birth.
  #--
  # FIXME: fails if the birthday falls on
  # February 29th
  #++
  # The DOB is returned as a Time object.

  def get_dob(person)
     ...

==== ꥹ

ꥹȤϰʲΤ褦ʵ椬դѥ饰դǤ

  * '*' ⤷ '-' ̤Υꥹ
  * +ԥꥪɤֹդꥹ
  * ե٥å+ԥꥪɤǥե٥åȥꥹ

㤨СΥѥ饰դϰʲΤ褦˽񤭤ޤ

  ꥹȤϰʲΤ褦ʵ椬դ
  ѥ饰դǤ
    * '*' ⤷ '-' ̤Υꥹ
    * +ԥꥪɤֹդꥹ
    * ե٥å+ԥꥪɤ
      ե٥åȥꥹ

==== ٥դꥹ

٥դꥹ(description list ȤƤФ)̤̾ǥ٥
ޤ

  [cat]   small domestic animal
  [+cat+] command to copy standard input

٥դꥹȤϥ2Ĥ٥θ֤ȤǤޡåפǤ롣
ξɽȤʤꡢ(2ĤθΥƥ)Ϻ·ˤʤ
ηܥɥȤΤۤ 'author' ΤȤǻȤ
ޤ

  cat::   small domestic animal
  +cat+:: command to copy standard input

ɤηΥ٥դꥹȤǤ⡢٥ƱԤ鵭񤭻Ϥ
ϡεƱǥȤǤҤȤޤȤʤޤޤ
٥μιԤ鵭񤭻Ϥ뤳ȤǤޤ٥ʸϤĹ
ʤʤ餳ۤɤ⤷ޤ󡣤ĤޤʲΤɤǤ
ȤȤǤ

  <tt>--output</tt> <i>name [, name]</i>::
      specify the name of one or more output files. If multiple
      files are present, the first is used as the index.

  <tt>--quiet:</tt>:: do not output the names, sizes, byte counts,
                      index areas, or bit ratios of units as
                      they are processed.

==== Ф

Ф ASCII ʸ=פȤޤ

  = Ф٥1
  == Ф٥2

ʲ٥ 34Ĥ³ޤ

==== 

()ASCIIʸΥϥե󻰤 '---' Ȥޤ

==== åΡܡΡץ饤

ʸǰʲΤ褦ʥޡåפǤޤ

 * å italic: _word_ ⤷ <em>text</em>
 * ܡ bold:  *word* ⤷ <b>text</b>
 * ץ饤 typewriter:  +word+ ⤷ <tt>text</tt>

줾2ķޤword ñϤȤǤޤ
ñȤΤϡե٥åȤʸӾʸȥ
ߤ鹽줿ʸǤ(äܸǤϻȤޤ)ޤ
ޡå׵ˡ\פȤʸ֤ȡޡåפ
ɽϰʲΤ褦ˤкޤ

  <em>å</em> _italic_::         \_word_ ⤷ \<em>text</em>
  <b>ܡ</b> *bold*::               \*word* ⤷ \<b>text</b>
  <tt>ץ饤</tt> +typewriter+:: \+word+ ⤷ \<tt>text</tt>

==== 饹᥽åɤؤΥ

Υ饹̾䥽ե̾᥽å̾(
ޤǤɤ#פդƤƤɤ)ϡưŪ˥󥯤ĥ
ޤ

==== 

http: mailto: ftp: www. ǻϤޤƥȤϥ֤ؤΥ󥯤Ƚ
̤ޤβե򻲾ȤƤ <IMG..> Ѵ
link: ǻϤޤϥեؤΥ󥯤ǤȤߤʤ--op
ǻꤷǥ쥯ȥ꤫ХѥȤʤޤ

label[url] ηǤϥѡ󥯤ĥޤξ label ɽ
졢url Ȥʤޤlabel ʣñޤǤ(
ξϤäȤäƤ)

̤Ȥ<em>{multi word label}[</em>url<em>]</em> ȤƤ

==== ᥽åɥѥ᡼

᥽åɤΥѥ᡼ȴ졢ɥȤΥ᥽åɵҤΤȤ
Ϥޤ᥽åɤ yield ƤǤϡyield ϤƤ
ѥ᡼⤽˽Ϥޤ

  def fred
    ...
    yield line, address

Τ褦ʥ᥽åФơʲνϤޤ

  fred() { |line, address| ... }

᥽å̾ľ ':yields: ' ޤॳȤ񤯤ȡνϤ
Ǥޤ

  def fred      # :yields: index, position
    ...
    yield line, address

Τ褦ˤȤʲνϤˤʤޤ

  fred() { |index, position| ... }

==== 

ޡåפ <tt> ʤɤǥХåå嵭ǥפǤ
ޤХåå弫Ȥɽ 2 Ϣ³ǥХåå
Ҥޤޤ<tt> ¦Ǥϸ³ޡå׵
(<tt><*_+</tt>)Хåå塢󥯵ˡϺޤ

:

: 

  \{ruby-lang.org}[www.ruby-lang.org] ϰʲΤ褦Ѵޤ

//emlist{
  {ruby-lang.org}[www.ruby-lang.org]
//}

: 饹᥽å

  \RDoc::RDoc#document ϰʲΤ褦Ѵޤ

//emlist{
  RDoc::RDoc#document
//}

: Υ̵(S 饹Ѥ)

  <tt>\S</tt> ϰʲΤ褦Ѵޤ

//emlist{
  <tt>S</tt>
//}



==== ̿

ˤ¾ˤʲ̿ޤ뤳ȤǤޤ

':yield:' ϥɥȽҤΰǤʲνҤϽ褦Ȥ
Ƥʬľ˽񤭤ޤۤˤʲΤ褦ʤΤޤ

===== Ϥ

: :nodoc: [all]

  ꤷǤɥȤ˴ޤޤ󡣥饹⥸塼ꤷ
  硢ľܴޤޤ᥽åɤ䥨ꥢ°άޤ
  ǥեȤǤϡꤷ⥸塼䥯饹˴ޤޤ⥸塼
  䥯饹ϥɥȤ ޤޤޤ򥪥դˤ all 
  Ҥäޤ

//emlist{
    module SM  #:nodoc:
      class Input
      end
    end
    module Markup #:nodoc: all
      class Output
      end
    end
//}

  ʾΥɤǤϡSM::Input ΥɥȤΤߤϤޤ

: :stopdoc: / :startdoc:

  ɥ(饹᥽åɤʤ)ɥȤ˴ޤ뤫ɤ
  椷ޤ㤨С륯饹˥ɥȤ˽Ϥʤ
  Ȥȡ :stopdoc: ֤ :startdoc: ֤ޤ礦
  ⤷ :startdoc: ֤ʤСΥ饹⥸塼Τɥ
  Ȥ˽Ϥʤʤ ޤ

: :doc:

  ꤷ᥽åɤ°Ū˥ɥȤ˴ޤޤ㤨
  Υץ饤١ȥ᥽åɤɥȤ˴ޤ᤿Ǥ

: :enddoc:

  ʹߤƤڥɥȤ˽Ϥޤ

: :notnew:

  ϥ󥹥󥹥᥽åɤ initialize ˤΤŬѤǤޤ̾
  RDoc  initialize ᥽åɤΥɥȤѥ᡼ºݤˤϥ饹
  ᥽å new ΤΤȲꤷinitialize  new Ϥ
  :notnew: ҤϤߤᤵޤinitialize ᥽åɤ
  protected ʤΤǡޥɥ饤 -a ꤹʤɤʤ¤ꡢ
  initialize ᥽åɤ˴ؤɥȤϽϤʤȤդƤ
  

===== ¾̿

: :include: filename

  ꤷ˻ꤷեޤեõǥ쥯
   --include ǻꤷΤȥȥǥ쥯ȥǤե
   :include: ֤̿ΤƱǥȤޤ

: :title: text

  ɥȤΥȥꤷޤޥɥ饤 --title ѥ᡼
  ƱƯ򤷤ޤ(ޥɥ饤ǤλΤۤͥ褵ޤ)

: :main: name

  ޥɥ饤 --main ѥ᡼ƱƯ򤷤ޤ


: :section: title

  򳫻Ϥޤ:section: θ֤ȥϤ
  θФȤʤޤơȤλĤʬϤΥ
  ƳʸȤʤޤθΥ᥽åɡꥢ°饹
  ϤΥ˴ޤޤޤ:section: ̿˲ԤäƤ⤫
  ޤ󡣤ϥɥȤˤϴޤޤ줺ޤȤޤäƱ
  ιԤ֥åνüˤä硢ޤΤᡢʲ
  Τ褦򤹤뤳Ȥ Ǥޤ

//emlist{
    # ----------------------------------------
    # This is the section that I wrote.
    # See it glisten in the noon-day sun.
    # ----------------------------------------
//}

: :call-seq:

  ǥեȤǤϥ᥽åɤΰ yield ΰѡƽϤޤ
  ꤷιԤ鼡ζԤޤǤ᥽åɸƤӽФȲᤷ
  Ϥ򤽤˽񤫤줿褦ѹޤ
