embeddock-example (empty) → 0.1
raw patch · 4 files changed
+107/−0 lines, 4 filesdep +basedep +embeddockdep +timesetup-changed
Dependencies added: base, embeddock, time
Files
- LICENSE +30/−0
- Setup.hs +2/−0
- embeddock-example.cabal +35/−0
- src/Embeddock/Example.hs +40/−0
+ LICENSE view
@@ -0,0 +1,30 @@+Copyright (c) 2013, Takayuki Muranushi++All rights reserved.++Redistribution and use in source and binary forms, with or without+modification, are permitted provided that the following conditions are met:++ * Redistributions of source code must retain the above copyright+ notice, this list of conditions and the following disclaimer.++ * Redistributions in binary form must reproduce the above+ copyright notice, this list of conditions and the following+ disclaimer in the documentation and/or other materials provided+ with the distribution.++ * Neither the name of Takayuki Muranushi nor the names of other+ contributors may be used to endorse or promote products derived+ from this software without specific prior written permission.++THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ embeddock-example.cabal view
@@ -0,0 +1,35 @@+-- Initial embeddock-example.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/++name: embeddock-example+version: 0.1+synopsis: Example of using embeddock.+description: embeddock is a Haskell source-code preprocessor. + It allows you to embed computer-generated + values in the documentation.+ ++homepage: https://github.com/nushio3/embeddock-example+bug-reports: https://github.com/nushio3/embeddock-example/issues++license: BSD3+license-file: LICENSE+author: Takayuki Muranushi+maintainer: muranushi@gmail.com+-- copyright: +category: Documentation+build-type: Simple+cabal-version: >=1.8++library+ hs-source-dirs: src/+ exposed-modules: Embeddock.Example + other-modules: + build-depends: base >=4.5 && <5+ , embeddock+ , time+++Source-Repository head+ Type: git+ Location: https://github.com/nushio3/embeddock-example
+ src/Embeddock/Example.hs view
@@ -0,0 +1,40 @@+{- | To use embeddock, place the following preprocessor pragma at the+ beginning of your source code.++ > {-# OPTIONS_GHC -F -pgmF embeddock -optF $EMBED$ #-}++ You can specify the embed string by @-optF@. The default embed+ string is "$" . Expressions in parenthesis that immediately follow+ the embed strings are treated as embed expression. Embed+ expressions are evaluated in the context of the module. The result+ should be of type string.++ Please look at the source code of this module for an usecase of+ @embeddock@.++ At the moment, embeddock is not compatible with one-liner comment "--"+ due to the backend lexer.+-}++{-# OPTIONS_GHC -F -pgmF embeddock -optF $EMBED$ #-}++++module Embeddock.Example where++import Data.Time+import System.IO.Unsafe++{- | An answer to the life, the universe and everything. The answer+is $EMBED$(show answer) .-}++answer :: Integer+answer = 6*7+++{- | The time this file was processed. The current time was+ $EMBED$(show now). Please refer to the Source to see how these+documents were generated. -}++now :: UTCTime+now = unsafePerformIO $ getCurrentTime