From c5ce6de385e0113149a0e643d5090d87dc3ad354 Mon Sep 17 00:00:00 2001 From: xecarlox94 Date: Wed, 13 Nov 2024 20:07:00 +0000 Subject: [PATCH] working on documentation --- haskell/README.md | 93 ++++++++++++++++++++++++++++++++++++++++++- haskell/dev_run.sh | 4 +- haskell/lib/Engine.hs | 2 +- haskell/lib/P2PRC.hs | 33 +++++++++++++++ 4 files changed, 128 insertions(+), 4 deletions(-) diff --git a/haskell/README.md b/haskell/README.md index e8cb455..70eb919 100644 --- a/haskell/README.md +++ b/haskell/README.md @@ -1,4 +1,95 @@ +::: {#package-header} +[p2prc-0.1.0.0: P2PRC haskell library]{.caption} -# P2PRC Haskell library doc +- [Contents](index.html) +- [Index](doc-index.html) +::: +::: {#content} +::: {#module-header} + -------------- ----------------------------------------- + Copyright Copyright (C) 2006-2024 John MacFarlane + License GNU GPL, version 2 or above + Maintainer John MacFarlane \ + Stability alpha + Portability portable + Safe Haskell Safe-Inferred + Language GHC2021 + -------------- ----------------------------------------- +P2PRC +::: + +::: {#description} +Description + +::: doc +This helper module exports the main writers, readers, and data structure +definitions from the Pandoc libraries. + +A typical application will chain together a reader and a writer to +convert strings from one format to another. For example, the following +simple program will act as a filter converting markdown fragments to +reStructuredText, using reference-style links instead of inline links: + + module Main where + import Text.Pandoc + import Data.Text (Text) + import qualified Data.Text.IO as T + + mdToRST :: Text -> IO Text + mdToRST txt = runIOorExplode $ + readMarkdown def txt + >>= writeRST def{ writerReferenceLinks = True } + + main :: IO () + main = do + T.getContents >>= mdToRST >>= T.putStrLn +::: +::: + +::: {#synopsis} +Synopsis + +- [runP2PRC](#v:runP2PRC) :: + [MapPortRequest](P2PRC.html#t:MapPortRequest "P2PRC") -\> + [IO]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/System-IO.html#t:IO "System.IO") + () +- [data]{.keyword} [MapPortRequest](#t:MapPortRequest) = + [MkMapPortRequest](#v:MkMapPortRequest) + [Int]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-Int.html#t:Int "Data.Int") + [String]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-String.html#t:String "Data.String") +::: + +::: {#interface} +# Documentation + +::: top +[runP2PRC]{#v:runP2PRC .def} :: +[MapPortRequest](P2PRC.html#t:MapPortRequest "P2PRC") -\> +[IO]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/System-IO.html#t:IO "System.IO") +() [\#](#v:runP2PRC){.selflink} + +::: doc +Hello World +::: +::: + +::: top +[data]{.keyword} [MapPortRequest]{#t:MapPortRequest .def} +[\#](#t:MapPortRequest){.selflink} + +::: {.subs .constructors} +Constructors + + -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- --- + [MkMapPortRequest]{#v:MkMapPortRequest .def} [Int]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-Int.html#t:Int "Data.Int") [String]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-String.html#t:String "Data.String")   + -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- --- +::: +::: +::: +::: + +::: {#footer} +Produced by [Haddock](http://www.haskell.org/haddock/) version 2.29.2 +::: diff --git a/haskell/dev_run.sh b/haskell/dev_run.sh index 869ecc4..949f6cc 100755 --- a/haskell/dev_run.sh +++ b/haskell/dev_run.sh @@ -1,3 +1,3 @@ rm -rf *pem client/ plugin/ server/ p2p/ p2prc.[pP]* config.json dist-newstyle/ &&\ - cabal clean #&&\ - # cabal run + cabal clean &&\ + cabal run diff --git a/haskell/lib/Engine.hs b/haskell/lib/Engine.hs index 17f748f..51dad78 100644 --- a/haskell/lib/Engine.hs +++ b/haskell/lib/Engine.hs @@ -42,7 +42,7 @@ import API -- TODO: publish haskell library -- - +-- | Hello World runP2PRC :: MapPortRequest -> IO () runP2PRC (MkMapPortRequest portNumber domainName) = do diff --git a/haskell/lib/P2PRC.hs b/haskell/lib/P2PRC.hs index 619eae6..b98db68 100644 --- a/haskell/lib/P2PRC.hs +++ b/haskell/lib/P2PRC.hs @@ -1,3 +1,36 @@ +{- | + Module : Text.Pandoc + Copyright : Copyright (C) 2006-2024 John MacFarlane + License : GNU GPL, version 2 or above + + Maintainer : John MacFarlane + Stability : alpha + Portability : portable + +This helper module exports the main writers, readers, and data +structure definitions from the Pandoc libraries. + +A typical application will chain together a reader and a writer +to convert strings from one format to another. For example, the +following simple program will act as a filter converting markdown +fragments to reStructuredText, using reference-style links instead of +inline links: + +> module Main where +> import Text.Pandoc +> import Data.Text (Text) +> import qualified Data.Text.IO as T +> +> mdToRST :: Text -> IO Text +> mdToRST txt = runIOorExplode $ +> readMarkdown def txt +> >>= writeRST def{ writerReferenceLinks = True } +> +> main :: IO () +> main = do +> T.getContents >>= mdToRST >>= T.putStrLn + +-} module P2PRC ( runP2PRC