Changeset 2725

Show
Ignore:
Timestamp:
05/05/05 17:18:51 (4 years ago)
Author:
autrijus
svk:copy_cache_prev:
4271
Message:

* haddockify the poems

Location:
src
Files:
27 modified

Legend:

Unmodified
Added
Removed
  • src/IMC.hs

    r2497 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -fth -cpp #-} 
    22 
    3 {- 
     3{-| 
    44    Parrot IMC implementation. 
    55 
    6     All that is gold does not glitter, 
    7     Not all those who wander are lost; 
    8     The old that is strong does not wither, 
    9     Deep roots are not reached by the frost. 
     6>   All that is gold does not glitter, 
     7>   Not all those who wander are lost; 
     8>   The old that is strong does not wither, 
     9>   Deep roots are not reached by the frost. 
    1010-} 
    1111 
  • src/Main.hs

    r2628 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts #-} 
    22 
    3 {- 
     3{-| 
    44    The Main REPL loop. 
    55 
    6     A ship then new they built for him 
    7     Of mithril and of elven-glass 
    8     With shining prow; no shaven oar 
    9     Nor sail she bore on silver mast; 
    10     The Silmaril as lantern light 
    11     And banner bright with living flame 
    12     To gleam thereon by Elbereth 
    13     Herself was set, who thither came... 
     6>   A ship then new they built for him 
     7>   Of mithril and of elven-glass 
     8>   With shining prow; no shaven oar 
     9>   Nor sail she bore on silver mast; 
     10>   The Silmaril as lantern light 
     11>   And banner bright with living flame 
     12>   To gleam thereon by Elbereth 
     13>   Herself was set, who thither came... 
     14 
    1415-} 
    1516 
  • src/Pugs/AST.hs

    r2713 r2725  
    22{-# OPTIONS_GHC -#include "UnicodeC.h" #-} 
    33 
    4 {- 
     4{-| 
    55    Abstract syntax tree. 
    66 
    7     Tall ships and tall kings 
    8     Three times three. 
    9     What brought they from the foundered land 
    10     Over the flowing sea? 
    11     Seven stars and seven stones 
    12     And one white tree. 
     7>   Tall ships and tall kings 
     8>   Three times three. 
     9>   What brought they from the foundered land 
     10>   Over the flowing sea? 
     11>   Seven stars and seven stones 
     12>   And one white tree. 
    1313-} 
    1414 
  • src/Pugs/Bind.hs

    r2469 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts #-} 
    22 
    3 {- 
     3{-| 
    44    Parameter binding. 
    55 
    6     A star was bound upon her brows, 
    7     A light was on her hair 
    8     As sun upon the golden boughs 
    9     In Lorien the fair... 
     6>   A star was bound upon her brows, 
     7>   A light was on her hair 
     8>   As sun upon the golden boughs 
     9>   In Lorien the fair... 
    1010-} 
    1111 
  • src/Pugs/Class.hs

    r2078 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -cpp #-} 
    22 
    3 {- 
     3{-| 
    44    Class meta-model.  (object meta-meta-model) 
    55 
    6     Learn now the lore of Living Creatures! 
    7     First name the four, the free peoples: 
    8     Eldest of all, the elf-children; 
    9     Dwarf the delver, dark are his houses; 
    10     Ent the earthborn, old as mountains; 
    11     Man the mortal, master of horses... 
     6>   Learn now the lore of Living Creatures! 
     7>   First name the four, the free peoples: 
     8>   Eldest of all, the elf-children; 
     9>   Dwarf the delver, dark are his houses; 
     10>   Ent the earthborn, old as mountains; 
     11>   Man the mortal, master of horses... 
    1212-} 
    1313 
  • src/Pugs/Compat.hs

    r2715 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -cpp #-} 
    22 
    3 {- 
     3{-| 
    44    POSIX calls and emulations. 
    55 
    6     And now all those lands lie under the wave. 
    7     And I walk in Ambarona, in Tauremorna, in Aldalome. 
    8     In my own land, in the country of Fangorn, 
    9     Where the roots are long, 
    10     And the years lie thicker than the leaves 
    11     In Tauremornalome. 
     6>   And now all those lands lie under the wave. 
     7>   And I walk in Ambarona, in Tauremorna, in Aldalome. 
     8>   In my own land, in the country of Fangorn, 
     9>   Where the roots are long, 
     10>   And the years lie thicker than the leaves 
     11>   In Tauremornalome. 
    1212-} 
    1313 
  • src/Pugs/Compile.hs

    r2458 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts #-} 
    22 
    3 {- 
     3{-| 
    44    Compiler interface. 
    55 
    6     And words unheard were spoken then 
    7     Of folk and Men and Elven-kin, 
    8     Beyond the world were visions showed 
    9     Forbid to those that dwell therein... 
     6>   And words unheard were spoken then 
     7>   Of folk and Men and Elven-kin, 
     8>   Beyond the world were visions showed 
     9>   Forbid to those that dwell therein... 
    1010-} 
    1111 
  • src/Pugs/Cont.hs

    r2488 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -fno-warn-unused-binds #-} 
    22 
    3 {- 
     3{-| 
    44    Continuation with shift/reset operators. 
    55 
    6     The Road goes ever on and on 
    7     Down from the door where it began. 
    8     Now far ahead the Road has gone, 
    9     And I must follow, if I can... 
     6>   The Road goes ever on and on 
     7>   Down from the door where it began. 
     8>   Now far ahead the Road has gone, 
     9>   And I must follow, if I can... 
    1010-} 
    1111 
  • src/Pugs/Context.hs

    r2520 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts #-} 
    22 
    3 {- 
     3{-| 
    44    Context propagators and equalizers. 
    55 
    6     Tree and flower and leaf and grass, 
    7     Let them pass! Let them pass! 
    8     Hill and water under sky, 
    9     Pass them by! Pass them by! 
     6>   Tree and flower and leaf and grass, 
     7>   Let them pass! Let them pass! 
     8>   Hill and water under sky, 
     9>   Pass them by! Pass them by! 
    1010-} 
    1111 
  • src/Pugs/Embed.hs

    r2656 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -cpp #-} 
    22 
    3 {- 
     3{-| 
    44    Embedded interpreters. 
    55 
    6     As Beren looked into her eyes 
    7     Within the shadows of her hair, 
    8     The trembling starlight of the skies 
    9     He saw there mirrored shimmering... 
     6>   As Beren looked into her eyes 
     7>   Within the shadows of her hair, 
     8>   The trembling starlight of the skies 
     9>   He saw there mirrored shimmering... 
    1010-} 
    1111 
  • src/Pugs/Eval.hs

    r2650 r2725  
    22{-# OPTIONS_GHC -#include "UnicodeC.h" #-} 
    33 
    4 {- 
     4{-| 
    55    Evaluation and reduction engine. 
    66 
    7     Home is behind, the world ahead, 
    8     And there are many paths to tread 
    9     Through shadows to the edge of night, 
    10     Until the stars are all alight. 
    11     Then world behind and home ahead, 
    12     We'll wander back to home and bed... 
     7>   Home is behind, the world ahead, 
     8>   And there are many paths to tread 
     9>   Through shadows to the edge of night, 
     10>   Until the stars are all alight. 
     11>   Then world behind and home ahead, 
     12>   We'll wander back to home and bed... 
    1313-} 
    1414 
  • src/Pugs/External.hs

    r2564 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -cpp #-} 
    22 
    3 {- 
     3{-| 
    44    External call utilities. 
    55 
    6     To the Sea, to the Sea! The white gulls are crying, 
    7     The wind is blowing, and the white foam is flying. 
    8     West, west away, the round sun is falling. 
    9     Grey ship, grey ship, do you hear them calling? 
     6>   To the Sea, to the Sea! The white gulls are crying, 
     7>   The wind is blowing, and the white foam is flying. 
     8>   West, west away, the round sun is falling. 
     9>   Grey ship, grey ship, do you hear them calling? 
    1010-} 
    1111 
  • src/Pugs/Help.hs

    r2502 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -cpp #-} 
    22 
    3 {- 
     3{-| 
    44    Online help and banner text. 
    55 
    6     But if of ships I now should sing, 
    7     what ship would come to me, 
    8     What ship would bear me ever back 
    9     across so wide a Sea? 
     6>   But if of ships I now should sing, 
     7>   what ship would come to me, 
     8>   What ship would bear me ever back 
     9>   across so wide a Sea? 
    1010-} 
    1111 
  • src/Pugs/Internals.hs

    r2628 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -fno-warn-orphans #-} 
    22 
    3 {- 
     3{-| 
    44    Internal utilities and library imports. 
    55 
    6     Though here at journey's end I lie 
    7     in darkness buried deep, 
    8     beyond all towers strong and high, 
    9     beyond all mountains steep, 
    10     above all shadows rides the Sun 
    11     and Stars for ever dwell: 
    12     I will not say the Day is done, 
    13     nor bid the Stars farewell. 
     6>   Though here at journey's end I lie 
     7>   in darkness buried deep, 
     8>   beyond all towers strong and high, 
     9>   beyond all mountains steep, 
     10>   above all shadows rides the Sun 
     11>   and Stars for ever dwell: 
     12>   I will not say the Day is done, 
     13>   nor bid the Stars farewell. 
    1414-} 
    1515 
  • src/Pugs/Junc.hs

    r2645 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts #-} 
    22 
    3 {- 
     3{-| 
    44    Junction logic. 
    55 
    6     Still round the corner there may wait 
    7     A new road or a secret gate, 
    8     And though we pass them by today, 
    9     Tomorrow we may come this way... 
     6>   Still round the corner there may wait 
     7>   A new road or a secret gate, 
     8>   And though we pass them by today, 
     9>   Tomorrow we may come this way... 
    1010-} 
    1111 
  • src/Pugs/Lexer.hs

    r2638 r2725  
    22{-# OPTIONS_GHC -#include "UnicodeC.h" #-} 
    33 
    4 {- 
     4{-| 
    55    Lexical analyzer. 
    66 
    7     No words were laid on stream or stone 
    8     When Durin woke and walked alone. 
    9     He named the nameless hills and dells; 
    10     He drank from yet untasted wells... 
     7>   No words were laid on stream or stone 
     8>   When Durin woke and walked alone. 
     9>   He named the nameless hills and dells; 
     10>   He drank from yet untasted wells... 
    1111-} 
    1212 
  • src/Pugs/Monads.hs

    r2628 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts #-} 
    22 
    3 {- 
     3{-| 
    44    Monad structures. 
    55 
    6     One Ring to rule them all, 
    7     One Ring to find them, 
    8     One Ring to bring them all 
    9     and in the darkness bind them... 
     6>   One Ring to rule them all, 
     7>   One Ring to find them, 
     8>   One Ring to bring them all 
     9>   and in the darkness bind them... 
    1010-} 
    1111 
  • src/Pugs/Parser.hs

    r2644 r2725  
    22{-# OPTIONS_GHC -#include "UnicodeC.h" #-} 
    33 
    4 {- 
     4{-| 
    55    Higher-level parser for building ASTs. 
    66 
    7     I sang of leaves, of leaves of gold, and leaves of gold there grew: 
    8     Of wind I sang, a wind there came and in the branches blew. 
    9     Beyond the Sun, beyond the Moon, the foam was on the Sea, 
    10     And by the strand of Ilmarin there grew a golden Tree... 
     7>   I sang of leaves, of leaves of gold, and leaves of gold there grew: 
     8>   Of wind I sang, a wind there came and in the branches blew. 
     9>   Beyond the Sun, beyond the Moon, the foam was on the Sea, 
     10>   And by the strand of Ilmarin there grew a golden Tree... 
    1111-} 
    1212 
  • src/Pugs/Pretty.hs

    r2645 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts #-} 
    22 
    3 {- 
     3{-| 
    44    Pretty printing for various data structures. 
    55 
    6     Galadriel! Galadriel! 
    7     Clear is the water of your well; 
    8     White is the stars in your white hand; 
    9     Unmarred, unstained is leaf and land 
    10     In Dwimordene, in Lorien 
    11     More fair than thoughts of Mortal Men. 
     6>   Galadriel! Galadriel! 
     7>   Clear is the water of your well; 
     8>   White is the stars in your white hand; 
     9>   Unmarred, unstained is leaf and land 
     10>   In Dwimordene, in Lorien 
     11>   More fair than thoughts of Mortal Men. 
    1212-} 
    1313 
  • src/Pugs/Prim.hs

    r2677 r2725  
    22{-# OPTIONS_GHC -#include "UnicodeC.h" #-} 
    33 
    4 {- 
     4{-| 
    55    Primitive operators. 
    66 
    7     There hammer on the anvil smote, 
    8     There chisel clove, and graver wrote; 
    9     There forged was blade, and bound was hilt; 
    10     The delver mined, the mason built... 
     7>   There hammer on the anvil smote, 
     8>   There chisel clove, and graver wrote; 
     9>   There forged was blade, and bound was hilt; 
     10>   The delver mined, the mason built... 
    1111-} 
    1212 
  • src/Pugs/Rule.hs

    r2009 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts #-} 
    22 
    3 {- 
     3{-| 
    44    Rule-based grammar engine. 
    55 
    6     From the ashes a fire shall be woken 
    7     A light from the shadows shall spring 
    8     Renewed shall be blade that was broken 
    9     The crownless again shall be king. 
     6>   From the ashes a fire shall be woken 
     7>   A light from the shadows shall spring 
     8>   Renewed shall be blade that was broken 
     9>   The crownless again shall be king. 
    1010-} 
    1111 
  • src/Pugs/Run.hs

    r2564 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -cpp #-} 
    22 
    3 {- 
     3{-| 
    44    Runtime engine. 
    55 
    6     The mountain throne once more is freed! 
    7     O! Wandering folk, the summons heed! 
    8     Come haste! Come haste! Across the waste! 
    9     The king of friend and kin has need... 
     6>   The mountain throne once more is freed! 
     7>   O! Wandering folk, the summons heed! 
     8>   Come haste! Come haste! Across the waste! 
     9>   The king of friend and kin has need... 
    1010-} 
    1111 
  • src/Pugs/Shell.hs

    r2497 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -cpp #-} 
    22 
    3 {- 
     3{-| 
    44    Interactive shell. 
    55 
    6     There is an inn, a merry old inn, 
    7     beneath an old grey hill, 
    8     And there they brew a beer so brown 
    9     That the Man in the Moon himself came down 
    10     one night to drink his fill... 
     6>   There is an inn, a merry old inn, 
     7>   beneath an old grey hill, 
     8>   And there they brew a beer so brown 
     9>   That the Man in the Moon himself came down 
     10>   one night to drink his fill... 
    1111-} 
    1212 
  • src/Pugs/Types.hs

    r2713 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -fno-warn-orphans -funbox-strict-fields #-} 
    22 
    3 {- 
     3{-| 
    44    Implementation Types. 
    55 
    6     Three Rings for the Elven-kings under the sky, 
    7     Seven for the Dwarf-lords in their halls of stone, 
    8     Nine for Mortal Men doomed to die, 
    9     One for the Dark Lord on his dark throne 
    10     In the Land of Mordor where the Shadows lie. 
     6>   Three Rings for the Elven-kings under the sky, 
     7>   Seven for the Dwarf-lords in their halls of stone, 
     8>   Nine for Mortal Men doomed to die, 
     9>   One for the Dark Lord on his dark throne 
     10>   In the Land of Mordor where the Shadows lie. 
    1111-} 
    1212 
  • src/RRegex.hs

    r1963 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts #-} 
    22 
    3 {- 
     3{-| 
    44    Regular expressions, based on PCRE. 
    55 
    6     A king he was on carven throne 
    7     In many-pillared halls of stone 
    8     With golden roof and silver floor, 
    9     And runes of power upon the door... 
     6>   A king he was on carven throne 
     7>   In many-pillared halls of stone 
     8>   With golden roof and silver floor, 
     9>   And runes of power upon the door... 
    1010-} 
    1111 
  • src/UTF8.lhs

    r1427 r2725  
    11{-# OPTIONS_GHC -fglasgow-exts -O #-} 
    22 
    3 {- 
     3{-| 
    44    UTF-8 handling. 
    55 
  • src/Unicode.hs

    r2575 r2725  
    99{-# OPTIONS_GHC -#include "UnicodeC.h" #-} 
    1010 
    11 {- 
     11{-| 
    1212    Unicode internals. 
    1313 
    14     Sí na veth bâden im derel 
    15     Vi dúath dofn tummen. 
    16     Atham meraid velig a tynd 
    17     Athan eryd bain beraidh. 
    18     Or 'waith bain nura Anor 
    19     A panlû elin cuinar 
    20     Ú-pedithon 'i-aur gwann' 
    21     Egor nai îl 'namarië'. 
     14>   Sí na veth bâden im derel 
     15>   Vi dúath dofn tummen. 
     16>   Atham meraid velig a tynd 
     17>   Athan eryd bain beraidh. 
     18>   Or 'waith bain nura Anor 
     19>   A panlû elin cuinar 
     20>   Ú-pedithon 'i-aur gwann' 
     21>   Egor nai îl 'namarië'. 
    2222-} 
    2323