IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2026-07-30 08:08:15 -05:00
Code Issues Packages Projects Releases Wiki Activity

Clarify some function documentation.

Browse Source 
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@7253 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Christian Stimming
2002-09-30 21:12:53 +00:00
parent 9c0e54444f
commit 352bdff101
1 changed files with 23 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/engine/Transaction.h
+23 -15
View File
@@ -142,18 +142,22 @@ GNCBook * xaccTransGetBook (Transaction *trans);
kvp_frame *xaccTransGetSlots(Transaction *trans);
void xaccTransSetSlots_nc(Transaction *t, kvp_frame *frm);
/* The xaccTransSetDateSecs() method will modify the posted date
* of the transaction. (Footnote: this shouldn't matter to a user,
* but anyone modifying the engine should understand that when
* xaccTransCommitEdit() is called, the date order of each of the
* component splits will be checked, and will be restored in
* ascending date order.)
/* The xaccTransSetDateSecs() method will modify the posted date of
* the transaction, specified by a time_t (see ctime(3)).
* xaccTransSetDatePostedSecs() is just an alias for
* xaccTransSetDateSecs() -- both functions access the same date.
*
* The xaccTransSetDate() method does the same thing as
* xaccTransSetDateSecs(), but takes a convenient day-month-year format.
* (Footnote: this shouldn't matter to a user, but anyone modifying
* the engine should understand that when xaccTransCommitEdit() is
* called, the date order of each of the component splits will be
* checked, and will be restored in ascending date order.)
*
* The xaccTransSetDatePostedTS() method does the same thing as
* xaccTransSetDateSecs(), but takes a struct timespec64.
* The xaccTransSetDate() method does the same thing as
* xaccTransSetDate[Posted]Secs(), but takes a convenient
* day-month-year format.
*
* The xaccTransSetDatePostedTS() method does the same thing as
* xaccTransSetDate[Posted]Secs(), but takes a struct timespec64.
*
*/
void xaccTransSetDate (Transaction *trans,
@@ -163,6 +167,7 @@ void xaccTransSetDatePostedSecs (Transaction *trans, time_t time);
void xaccTransSetDatePostedTS (Transaction *trans,
const Timespec *ts);
/* Modify the date of when the transaction was entered. */
void xaccTransSetDateEnteredSecs (Transaction *trans, time_t time);
void xaccTransSetDateEnteredTS (Transaction *trans,
const Timespec *ts);
@@ -218,15 +223,18 @@ SplitList * xaccTransGetSplitList (Transaction *trans);
const char * xaccTransGetNum (Transaction *trans);
const char * xaccTransGetDescription (Transaction *trans);
const char * xaccTransGetNotes (Transaction *trans);
/* Retrieve the posted date of the transaction. (Although having
different function names, GetDate and GetDatePosted refer to the
same single date.)*/
time_t xaccTransGetDate (Transaction *trans);
void xaccTransGetDatePostedTS (Transaction *trans, Timespec *ts);
void xaccTransGetDateEnteredTS (Transaction *trans, Timespec *ts);
Timespec xaccTransRetDateEnteredTS (Transaction *trans);
Timespec xaccTransRetDatePostedTS (Transaction *trans);
/* Retrieve the date of when the transaction was entered. */
void xaccTransGetDateEnteredTS (Transaction *trans, Timespec *ts);
Timespec xaccTransRetDateEnteredTS (Transaction *trans);
/* Dates and txn-type for A/R and A/P "invoice" postings */
Timespec xaccTransRetDateDueTS (Transaction *trans);
void xaccTransGetDateDueTS (Transaction *trans, Timespec *ts);