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

lib: Add documentation for CBCSubreportSpec.

Browse Source
This commit is contained in:
Stephen Morgan 2020-10-23 23:15:32 +11:00 committed by Simon Michael
parent 795134777c
commit db97fae348
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
hledger-lib/Hledger/Reports/ReportTypes.hs
View File

@ -153,11 +153,13 @@ data CompoundPeriodicReport a b = CompoundPeriodicReport
-- | Description of one subreport within a compound balance report.
-- Part of a "CompoundBalanceCommandSpec", but also used in hledger-lib.
data CBCSubreportSpec a = CBCSubreportSpec
{ cbcsubreporttitle :: String
, cbcsubreportquery :: Journal -> Query
, cbcsubreportoptions :: ReportOpts -> ReportOpts
, cbcsubreporttransform :: PeriodicReport DisplayName MixedAmount -> PeriodicReport a MixedAmount
, cbcsubreportincreasestotal :: Bool
{ cbcsubreporttitle :: String -- ^ The title to use for the subreport
, cbcsubreportquery :: Journal -> Query -- ^ The Query to use for the subreport
, cbcsubreportoptions :: ReportOpts -> ReportOpts -- ^ A function to transform the ReportOpts used to produce the subreport
, cbcsubreporttransform :: PeriodicReport DisplayName MixedAmount -> PeriodicReport a MixedAmount -- ^ A function to transform the result of the subreport
, cbcsubreportincreasestotal :: Bool -- ^ Whether the subreport and overall report total are of the same sign (e.g. Assets are normally
-- positive in a balance sheet report, as is the overall total. Liabilities are normally of the
-- opposite sign.)
}