mirror of
https://github.com/simonmichael/hledger.git
synced 2024-11-07 21:15:19 +03:00
;doc: main module haddock cleanups
This commit is contained in:
parent
2e06c8dc27
commit
fffae7f578
@ -1,4 +1,25 @@
|
||||
{-# LANGUAGE OverloadedStrings #-}
|
||||
{-|
|
||||
|
||||
This is the root of the @hledger-lib@ package and the @Hledger.*@ module hierarchy.
|
||||
hledger-lib is the core engine used by various hledger UIs and tools,
|
||||
providing the main data types, file format parsers, reporting logic, and utilities.
|
||||
|
||||
This is also the starting point for hledger's haddock docs,
|
||||
which describe Hledger's implementation for developers.
|
||||
These can be viewed
|
||||
in your code editor,
|
||||
or in a web browser (eg with @make haddock@),
|
||||
or on Hackage (starting at [hledger-lib:Hledger](https://hackage.haskell.org/package/hledger-lib/docs/Hledger.html)).
|
||||
|
||||
== See also:
|
||||
|
||||
- hledger:Hledger.Cli
|
||||
- hledger-ui:Hledger.UI
|
||||
- hledger-web:Hledger.Web
|
||||
- [The README files](https://github.com/search?q=repo%3Asimonmichael%2Fhledger+path%3A**%2FREADME*&type=code&ref=advsearch)
|
||||
- [The high-level developer docs](https://hledger.org/dev.html)
|
||||
|
||||
-}
|
||||
|
||||
module Hledger (
|
||||
module X
|
||||
|
@ -1,5 +1,16 @@
|
||||
{-|
|
||||
Re-export the modules of the hledger-ui program.
|
||||
|
||||
This is the root module of the @hledger-ui@ package,
|
||||
providing hledger's terminal user interface.
|
||||
The main function, command-line options, and terminal themes are exported.
|
||||
|
||||
== See also:
|
||||
|
||||
- hledger-lib:Hledger
|
||||
- hledger:Hledger.Cli
|
||||
- [The README files](https://github.com/search?q=repo%3Asimonmichael%2Fhledger+path%3A**%2FREADME*&type=code&ref=advsearch)
|
||||
- [The high-level developer docs](https://hledger.org/dev.html)
|
||||
|
||||
-}
|
||||
|
||||
module Hledger.UI (
|
||||
|
@ -1,5 +1,16 @@
|
||||
{-|
|
||||
Re-export the modules of the hledger-web program.
|
||||
|
||||
This is the root module of the @hledger-web@ package,
|
||||
providing hledger's web user interface and JSON API.
|
||||
The main function and command-line options are exported.
|
||||
|
||||
== See also:
|
||||
|
||||
- hledger-lib:Hledger
|
||||
- hledger:Hledger.Cli
|
||||
- [The README files](https://github.com/search?q=repo%3Asimonmichael%2Fhledger+path%3A**%2FREADME*&type=code&ref=advsearch)
|
||||
- [The high-level developer docs](https://hledger.org/dev.html)
|
||||
|
||||
-}
|
||||
|
||||
module Hledger.Web (
|
||||
|
@ -17,10 +17,7 @@ and cmdargs:System.Concole.CmdArgs.Explicit
|
||||
|
||||
See also:
|
||||
|
||||
- [hledger-lib:Hledger]("Hledger")
|
||||
- [hledger:Hledger.Cli]("Hledger.Cli")
|
||||
- [hledger-ui:Hledger.UI]("Hledger.UI")
|
||||
- [hledger-web:Hledger.Web]("Hledger.Web")
|
||||
- hledger-lib:Hledger
|
||||
- [The README files](https://github.com/search?q=repo%3Asimonmichael%2Fhledger+path%3A**%2FREADME*&type=code&ref=advsearch)
|
||||
- [The high-level developer docs](https://hledger.org/dev.html)
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user