Move documentation of public transaction functions to alpm.h

1 files changed, 5 insertions, 23 deletions

diff --git a/lib/libalpm/trans.c b/lib/libalpm/trans.c
index 309a56a3..c5af7c69 100644
--- a/lib/libalpm/trans.c
+++ b/lib/libalpm/trans.c
@@ -97,13 +97,7 @@ static int remove_lock(pmhandle_t *handle)
 	return(0);
 }
 
-/** Initialize the transaction.
- * @param flags flags of the transaction (like nodeps, etc)
- * @param event event callback function pointer
- * @param conv question callback function pointer
- * @param progress progress callback function pointer
- * @return 0 on success, -1 on error (pm_errno is set accordingly)
- */
+/** Initialize the transaction. */
 int SYMEXPORT alpm_trans_init(pmtransflag_t flags,
 		alpm_trans_cb_event event, alpm_trans_cb_conv conv,
 		alpm_trans_cb_progress progress)
@@ -176,11 +170,7 @@ static alpm_list_t *check_arch(alpm_list_t *pkgs)
 	return(invalid);
 }
 
-/** Prepare a transaction.
- * @param data the address of an alpm_list where a list
- * of pmdepmissing_t objects is dumped (conflicting packages)
- * @return 0 on success, -1 on error (pm_errno is set accordingly)
- */
+/** Prepare a transaction. */
 int SYMEXPORT alpm_trans_prepare(alpm_list_t **data)
 {
 	pmtrans_t *trans;
@@ -226,11 +216,7 @@ int SYMEXPORT alpm_trans_prepare(alpm_list_t **data)
 	return(0);
 }
 
-/** Commit a transaction.
- * @param data the address of an alpm_list where detailed description
- * of an error can be dumped (ie. list of conflicting files)
- * @return 0 on success, -1 on error (pm_errno is set accordingly)
- */
+/** Commit a transaction. */
 int SYMEXPORT alpm_trans_commit(alpm_list_t **data)
 {
 	pmtrans_t *trans;
@@ -271,9 +257,7 @@ int SYMEXPORT alpm_trans_commit(alpm_list_t **data)
 	return(0);
 }
 
-/** Interrupt a transaction.
- * @return 0 on success, -1 on error (pm_errno is set accordingly)
- */
+/** Interrupt a transaction. */
 int SYMEXPORT alpm_trans_interrupt(void)
 {
 	pmtrans_t *trans;
@@ -293,9 +277,7 @@ int SYMEXPORT alpm_trans_interrupt(void)
 	return(0);
 }
 
-/** Release a transaction.
- * @return 0 on success, -1 on error (pm_errno is set accordingly)
- */
+/** Release a transaction. */
 int SYMEXPORT alpm_trans_release(void)
 {
 	pmtrans_t *trans;