slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix api docs

Browse Source
This commit is contained in:
Simon Michael 2012-03-07 16:05:04 +00:00
parent 5b749ab8a2
commit 7f3b990394
4 changed files with 20 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Makefile
View File

@ -60,8 +60,8 @@ HADDOCKSOURCEFILES:= \
hledger-web/Hledger/*hs \ hledger-web/Hledger/*hs \
hledger-web/Hledger/*/*hs \ hledger-web/Hledger/*/*hs \
hledger-web/Hledger/Web/Settings/*hs \ hledger-web/Hledger/Web/Settings/*hs \
hledger-vty/Hledger/*hs \ # hledger-vty/Hledger/*hs \
hledger-vty/Hledger/*/*hs # hledger-vty/Hledger/*/*hs
# hledger-chart/Hledger/*hs # hledger-chart/Hledger/*hs
# hledger-chart/Hledger/*/*hs # hledger-chart/Hledger/*/*hs
@ -549,8 +549,10 @@ HADDOCK=haddock --no-warnings --prologue .haddockprologue #--optghc='-hide-packa
printf "\nThis haddock covers all hledger-* packages, for individual package haddocks see hackage.\n" >>$@ printf "\nThis haddock covers all hledger-* packages, for individual package haddocks see hackage.\n" >>$@
# generate api docs for the whole project # generate api docs for the whole project
# we define HADDOCK to disable cabal-file-th code which requires a cabal file in the current dir
haddock: .haddockprologue haddock: .haddockprologue
$(HADDOCK) --title "hledger-* API docs" \ $(HADDOCK) --title "hledger-* API docs" \
--optghc '-DHADDOCK' \
-o site/api \ -o site/api \
--html \ --html \
--source-module=src/%{MODULE/./-}.html \ --source-module=src/%{MODULE/./-}.html \

14
hledger-web/Hledger/Web/Foundation.hs
View File

@ -77,21 +77,17 @@ instance Yesod App where
defaultLayout widget = do defaultLayout widget = do
master <- getYesod master <- getYesod
mmsg <- getMessage mmsg <- getMessage
-- We break up the default layout into two components: -- We break up the default layout into two components:
-- default-layout is the contents of the body tag, and -- default-layout is the contents of the body tag, and
-- default-layout-wrapper is the entire page. Since the final -- default-layout-wrapper is the entire page. Since the final
-- value passed to hamletToRepHtml cannot be a widget, this allows -- value passed to hamletToRepHtml cannot be a widget, this allows
-- you to use normal widget features in default-layout. -- you to use normal widget features in default-layout.
-- pc <- widgetToPageContent $ do
pc <- widgetToPageContent $ do -- $(widgetFile "normalize")
-- $(widgetFile "normalize") -- $(widgetFile "default-layout")
-- $(widgetFile "default-layout")
-- hamletToRepHtml $(hamletFile "templates/default-layout-wrapper.hamlet") -- hamletToRepHtml $(hamletFile "templates/default-layout-wrapper.hamlet")
pc <- widgetToPageContent $ do
widget widget
-- addCassius $(cassiusFile "default-layout")
-- hamletToRepHtml $(hamletFile "default-layout")
hamletToRepHtml [$hamlet| hamletToRepHtml [$hamlet|
!!! !!!
<html <html

7
hledger-web/Hledger/Web/Options.hs
View File

@ -1,4 +1,4 @@
{-# LANGUAGE TemplateHaskell #-} {-# LANGUAGE TemplateHaskell, CPP #-}
{-| {-|
-} -}
@ -15,8 +15,13 @@ import Hledger.Cli hiding (progname,version,prognameandversion)
import Hledger.Web.Settings import Hledger.Web.Settings
progname, version :: String progname, version :: String
#if HADDOCK
progname = ""
version = ""
#else
progname = $(packageVariable (pkgName . package)) progname = $(packageVariable (pkgName . package))
version = $(packageVariable (pkgVersion . package)) version = $(packageVariable (pkgVersion . package))
#endif
prognameandversion = progname ++ " " ++ version :: String prognameandversion = progname ++ " " ++ version :: String
defbaseurlexample = (reverse $ drop 4 $ reverse $ defbaseurl defport) ++ "PORT" defbaseurlexample = (reverse $ drop 4 $ reverse $ defbaseurl defport) ++ "PORT"

5
hledger/Hledger/Cli/Version.hs
View File

@ -19,8 +19,13 @@ import Hledger.Utils
-- package name and version from the cabal file -- package name and version from the cabal file
progname, version, prognameandversion :: String progname, version, prognameandversion :: String
#if HADDOCK
progname = ""
version = ""
#else
progname = $(packageVariable (pkgName . package)) progname = $(packageVariable (pkgName . package))
version = $(packageVariable (pkgVersion . package)) version = $(packageVariable (pkgVersion . package))
#endif
prognameandversion = progname ++ " " ++ version prognameandversion = progname ++ " " ++ version
-- developer build version strings include PATCHLEVEL (number of -- developer build version strings include PATCHLEVEL (number of