docs: haddock fixes
This commit is contained in:
		
							parent
							
								
									d5f69b853c
								
							
						
					
					
						commit
						a50d2fedd7
					
				@ -117,16 +117,16 @@ import System.IO.UTF8
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-- | A balance report is a chart of accounts with balances, and their grand total.
 | 
					-- | A balance report is a chart of accounts with balances, and their grand total.
 | 
				
			||||||
type BalanceReport = ([BalanceReportItem] -- ^ line items, one per account
 | 
					type BalanceReport = ([BalanceReportItem] -- line items, one per account
 | 
				
			||||||
                     ,MixedAmount         -- ^ total balance of all accounts
 | 
					                     ,MixedAmount         -- total balance of all accounts
 | 
				
			||||||
                     )
 | 
					                     )
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-- | The data for a single balance report line item, representing one account.
 | 
					-- | The data for a single balance report line item, representing one account.
 | 
				
			||||||
type BalanceReportItem = (AccountName  -- ^ full account name
 | 
					type BalanceReportItem = (AccountName  -- full account name
 | 
				
			||||||
                         ,AccountName  -- ^ account name elided for display: the leaf name,
 | 
					                         ,AccountName  -- account name elided for display: the leaf name,
 | 
				
			||||||
                                       -- prefixed by any boring parents immediately above
 | 
					                                       -- prefixed by any boring parents immediately above
 | 
				
			||||||
                         ,Int          -- ^ account depth within this report, excludes boring parents
 | 
					                         ,Int          -- account depth within this report, excludes boring parents
 | 
				
			||||||
                         ,MixedAmount) -- ^ account balance, includes subs unless --flat is present
 | 
					                         ,MixedAmount) -- account balance, includes subs unless --flat is present
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-- | Print a balance report.
 | 
					-- | Print a balance report.
 | 
				
			||||||
balance :: [Opt] -> [String] -> Journal -> IO ()
 | 
					balance :: [Opt] -> [String] -> Journal -> IO ()
 | 
				
			||||||
 | 
				
			|||||||
@ -28,12 +28,12 @@ import Text.ParserCombinators.Parsec
 | 
				
			|||||||
-- | A register report is a list of postings to an account or set of
 | 
					-- | A register report is a list of postings to an account or set of
 | 
				
			||||||
-- accounts, with a running total. Postings may be actual postings, or
 | 
					-- accounts, with a running total. Postings may be actual postings, or
 | 
				
			||||||
-- virtual postings aggregated over a reporting interval.
 | 
					-- virtual postings aggregated over a reporting interval.
 | 
				
			||||||
type RegisterReport = [RegisterReportItem] -- ^ line items, one per posting
 | 
					type RegisterReport = [RegisterReportItem] -- line items, one per posting
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-- | The data for a single register report line item, representing one posting.
 | 
					-- | The data for a single register report line item, representing one posting.
 | 
				
			||||||
type RegisterReportItem = (Maybe (Day, String) -- ^ transaction date and description if this is the first posting
 | 
					type RegisterReportItem = (Maybe (Day, String) -- transaction date and description if this is the first posting
 | 
				
			||||||
                          ,Posting             -- ^ the posting
 | 
					                          ,Posting             -- the posting
 | 
				
			||||||
                          ,MixedAmount         -- ^ balance so far
 | 
					                          ,MixedAmount         -- balance so far
 | 
				
			||||||
                          )
 | 
					                          )
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-- | Print a register report.
 | 
					-- | Print a register report.
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
		Reference in New Issue
	
	Block a user