RDoc

rdoc är gjord av två huvuddelar.

En rdoc , ett verktyg för att generera HTML-dokumentation. Det andra är ri , ett verktyg för att skapa dokumentation för Ruby kommandoradsgränssnitt.

För att kunna korrekt använda rdoc måste utvecklaren ändra hur han lägger kommentarer till sin källkod.

rdoc använder en specifik källkod kommentarer struktur, så att de lätt kan extraheras och hjälpa fylla dokumentationen webbplatsen.

rdoc kommentar struktur är mycket framgångsrik, som används av många liknande dokumentations generatorer som skapats för andra programmeringsspråk

Vad är nytt i den här versionen.

• rdoc kan nu producera översättningsfiler för användning med gettext.

Vad är nytt i version 4.2.0:

• rdoc kan nu producera översättningsfiler för användning med gettext .

Vad är nytt i version 4.1.0.

• Förbättrad tillgänglighet av HTML-utdata
• Utseendet på rdoc har uppdaterats.

Vad är nytt i version 4.0.0.

• Lade Wiki som ett format som stöds
• ri kan nu visa sidor (README osv.).
• Removed globala tillstånd från rdoc. Rdoc :: Store innehar dokumentationen trädet och ansluter föraren att de parsers och generator.

Vad är nytt i version 3.12:

• Mindre förbättringar:
• Lade utvecklare dokument som innehåller en översikt över hur rdoc fungerar och hur man lägger till nya funktioner till rdoc.
• Förbättrad titel för HTML-utdata att inkludera --title i titeln elementet.
• rdoc --pipe förstår nu --markup.
• rdoc stöder nu irc-system hyperlänkar.
• Buggfixar:
• Fast titel på HTML-utdata för sidor.
• Fast tolkning av icke-indragna HEREDOC.
• Fast tolkning av% w [] och andra% litteraler.
• Fast pil ersättare i HTML-utdata munging rymdskeppet operatören.
• Verbatim sektioner med ERB som matchar ruby ​​koden vitlista inte längre syntax-markerad.
• Radslut på windows normaliseras omedelbart efter att ha läst med binmode.
• rdoc bättre förstår direktiv för kommentarer. Kommentar direktiv finns nu överallt i flera linjer kommentarer.
• Tidy länkar till metoder visa etiketten igen.
• rdoc :: Parser :: C kan nu hitta kommentarer direkt ovanför rb_define_class_under.
• I rdoc, backsteg och ansi format, etiketter och anteckningar utan kroppar visas nu.
• I rdoc, backsteg och ansi format, blank mellan etiketten eller notera och tjocktarmen är nu avskalade.

Vad är nytt i version 3.11:

• Buggfixar:
• Undvik analysera Sökord Filer som ingår i ädelstenar.

Vad är nytt i version 3.9.2:

• Bugfix:
• lossas TIDYLINK regexp att låta innehållet i länken avsnittet som: & # x3c; tt & # x3e, {foo} [rdoc-ref: SomeClass] & # x3c; / tt & # x3e;
• I HTML utgångs rubriker är maximerad till & # x3c; tt & # x3e; & # x3c, h6 & # x3e; & # x3c; / tt & # x3e; igen.

Vad är nytt i version 3.9.1:

• Buggfixar:
• Fix rdoc :: Markup parser för ett huvud följt av en icke-text token.
• Fix rdoc :: Markup :: ToHtmlCrossref # gen_url för icke - & # x3c; tt & # x3e, rdoc-ref & # x3c; / tt & # x3e; länkar.
• Fix felrapport URL när rdoc kraschar.

Vad är nytt i version 3.8:

• Mindre förbättringar:
• rdoc :: Parser :: C kan nu upptäcka metoder på ENV och argF.
• rdoc :: Parser :: C vet nu om rb_cSocket och rb_mDL.
• Buggfixar:
• Uppdatera objekt i en ri datalagrings med nya data nu avlägsnar metoder, omfattar, konstanter och alias.

Vad är nytt i version 3.7:

• Mindre förbättringar:
• Nytt direktiv: kategori: som gör metoder som ska grupperas i sektioner renare. Se rdoc :: Markup för mer information.
• Dokument-klass för rdoc :: Parser :: C stöder nu Foo :: KONST samt KONST.
• ri metod utgång är nu en kommaseparerad lista när den visas interaktivt.
• rdoc :: ClassModule # samman nu föredrar argumentet information över mottagarens (nu beter sig som Hash # samman! Istället för en bakåt Hash # merge!).
• rdoc :: Markup # konvertera nu accepterar en rdoc :: Markup :: Dokument exempel
• rdoc äger nu koden för att generera rdoc och ri data när pärlor installera
• Inkom rdoc :: rdoc :: återställa
• Inkom rdoc :: CodeObject # filnamn
• Buggfixar:
• ri kraschar inte längre när man försöker att slutföra en vanlig
• rdoc :: Parser :: Ruby inte längre äter innehåll när = börjar / = slut dokumentation block följs av en dokumenterbart post. Utfärda # 41 av MGN.
• rdoc :: Markup :: Forma och klasser nu låta en valfri + markup + parameter för att lägga till anpassade uppmärkning. Exemplet i rdoc :: Markup :: Forma kommer nu att arbeta.
• rdoc :: Parser :: C kan nu skilja mellan klassmetoder och instansmetoder i Dokument-metoden.
• rdoc kodar nu filnamn i utgångs kodning.
• ri dataframställning för metod alias inte längre har samma klass i #full_name