Skip to content

Commit

Permalink
Doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
@eldy
eldy committed Mar 17, 2015
1 parent 84bea61 commit 6e25169
Show file tree
Hide file tree
Showing 16 changed files with 50 additions and 66 deletions.
4 changes: 2 additions & 2 deletions htdocs/compta/bank/class/account.class.php
View file
Expand Up @@ -39,12 +39,12 @@ class Account extends CommonObject
public $table_element='bank_account';

/**
* //TODO: Discuss this. $rowid is preferred over $id
* @var
* @var int Use id instead of rowid
* @deprecated
*/
var $rowid;
var $id;

var $ref;
var $label;
//! 1=Compte courant/check/carte, 2=Compte liquide, 0=Compte épargne
Expand Down
65 changes: 20 additions & 45 deletions htdocs/contrat/class/contrat.class.php
View file
Expand Up @@ -89,66 +89,49 @@ class Contrat extends CommonObject
var $product;

/**
* TODO: Which is the correct one?
* Author of the contract
* @var
*/
var $user_author;

/**
* TODO: Which is the correct one?
* Author of the contract
* @var User
* @var int Id of user author of the contract
*/
public $user_creation;
public $fk_user_author;

/**
* TODO: Which is the correct one?
* Author of the contract
* @var int
*/
public $fk_user_author;
public $user_author_id;

/**
* TODO: Which is the correct one?
* Author of the contract
* @var int
* @var User Object user that create the contract. Set by the info method.
*/
public $user_author_id;
public $user_creation;

/**
* @var User
* @var User Object user that close the contract. Set by the info method.
*/
public $user_cloture;

/**
* Date of creation
* @var int
* @var int Date of creation
*/
var $date_creation;

/**
* Date of last modification
* Not filled until you call ->info()
* @var int
* @var int Date of last modification. Not filled until you call ->info()
*/
public $date_modification;

/**
* Date of validation
* @var int
* @var int Date of validation
*/
var $date_validation;

/**
* Date when contract was signed
* @var int
* @var int Date when contract was signed
*/
var $date_contrat;

/**
* Date of contract closure
* @var int
* @var int Date of contract closure
* @deprecated we close contract lines, not a contract
*/
var $date_cloture;
Expand All @@ -157,21 +140,15 @@ class Contrat extends CommonObject
var $commercial_suivi_id;

/**
* @deprecated Use note_private or note_public instead
*/
var $note;

/**
* Private note
* @var string
* @var string Private note
*/
var $note_private;

/**
* Public note
* @var string
* @var string Public note
*/
var $note_public;

var $modelpdf;

/**
Expand All @@ -184,8 +161,7 @@ class Contrat extends CommonObject
var $extraparams=array();

/**
* Contract lines
* @var ContratLigne[]
* @var ContratLigne[] Contract lines
*/
var $lines=array();

Expand Down Expand Up @@ -569,7 +545,6 @@ function fetch($id,$ref='')
$this->commercial_signature_id = $result["fk_commercial_signature"];
$this->commercial_suivi_id = $result["fk_commercial_suivi"];

$this->note = $result["note_private"]; // deprecated
$this->note_private = $result["note_private"];
$this->note_public = $result["note_public"];
$this->modelpdf = $result["model_pdf"];
Expand Down Expand Up @@ -726,7 +701,7 @@ function fetch_lines()
// Retreive all extrafield for propal
// fetch optionals attributes and labels
$line->fetch_optionals($line->id,$extralabelsline);

$this->lines[] = $line;

//dol_syslog("1 ".$line->desc);
Expand Down Expand Up @@ -822,13 +797,13 @@ function fetch_lines()
if ($line->statut == 4 && (! empty($line->date_fin_prevue) && $line->date_fin_prevue < $now)) $this->nbofservicesexpired++;
if ($line->statut == 5) $this->nbofservicesclosed++;


// Retreive all extrafield for propal
// fetch optionals attributes and labels

$line->fetch_optionals($line->id,$extralabelsline);


$this->lines[] = $line;

$total_ttc+=$objp->total_ttc;
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/modAskPriceSupplier.class.php
View file
Expand Up @@ -21,7 +21,7 @@
*/

/**
* \defgroup askpricesupplier Module to request supplier price proposals
* \defgroup askpricesupplier Module askpricesupplier
* \brief Module to request supplier price proposals
* \file htdocs/core/modules/modAskPriceSupplier.class.php
* \ingroup askpricesupplier
Expand Down
9 changes: 4 additions & 5 deletions htdocs/core/modules/modExpenseReport.class.php
View file
Expand Up @@ -17,14 +17,13 @@
*/

/**
* \defgroup Indicateurs
* \brief Module indicateurs
* Such a file must be copied into htdocs/includes/module directory.
* \defgroup expensereport Module expensereport
* \brief Module to manage expense report. Replace old module Deplacement.
*/

/**
* \file htdocs/indicateurs/core/modules/modExpenseReport.class.php
* \ingroup indicateur
* \file htdocs/core/modules/modExpenseReport.class.php
* \ingroup expensereport
* \brief Description and activation file for module ExpenseReport
*/
include_once(DOL_DOCUMENT_ROOT ."/core/modules/DolibarrModules.class.php");
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/modFTP.class.php
View file
Expand Up @@ -17,7 +17,7 @@
*/

/**
* \defgroup ftp Module FTP
* \defgroup ftp Module ftp
* \brief Module for FTP client module
* \file htdocs/core/modules/modFTP.class.php
* \ingroup ftp
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/modFicheinter.class.php
View file
Expand Up @@ -21,7 +21,7 @@
*/

/**
* \defgroup ficheinter Module intervention cards
* \defgroup ficheinter Module Interventions
* \brief Module to manage intervention cards
* \file htdocs/core/modules/modFicheinter.class.php
* \ingroup ficheinter
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/modGeoIPMaxmind.class.php
View file
Expand Up @@ -16,7 +16,7 @@
*/

/**
* \defgroup geoip Module GeoIP
* \defgroup geoip Module geoipmaxmind
* \brief Module to make geoip conversions
* \file htdocs/core/modules/modGeoIPMaxmind.class.php
* \ingroup geoip
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/modResource.class.php
View file
Expand Up @@ -17,7 +17,7 @@
*/

/**
* \defgroup resource Resource module
* \defgroup resource Module resource
* \brief Resource module descriptor.
* \file core/modules/modResource.class.php
* \ingroup resource
Expand Down
1 change: 1 addition & 0 deletions htdocs/expensereport/ajax/ajaxprojet.php
View file
Expand Up @@ -20,6 +20,7 @@

/**
* \file htdocs/expensereport/ajax/ajaxprojet.php
* \ingroup expensereport
* \brief File to return Ajax response on third parties request
*/

Expand Down
13 changes: 7 additions & 6 deletions htdocs/expensereport/card.php
View file
Expand Up @@ -19,7 +19,8 @@

/**
* \file htdocs/expensereport/card.php
* \brief Page for trip and expense card
* \ingroup expensereport
* \brief Page for trip and expense report card
*/

$res=0;
Expand Down Expand Up @@ -1135,7 +1136,7 @@
print '</td>';
print '</tr>';
}

// Public note
print '<tr>';
print '<td class="border" valign="top">' . $langs->trans('NotePublic') . '</td>';
Expand All @@ -1155,7 +1156,7 @@
print $doleditor->Create(1);
print '</td></tr>';
}

print '<tbody>';
print '</table>';

Expand Down Expand Up @@ -1286,7 +1287,7 @@
print '</td></tr>';

}

// Public note
print '<tr>';
print '<td class="border" valign="top">' . $langs->trans('NotePublic') . '</td>';
Expand All @@ -1295,7 +1296,7 @@
$doleditor = new DolEditor('note_public', $object->note_public, '', 80, 'dolibarr_notes', 'In', 0, false, true, ROWS_3, 70);
print $doleditor->Create(1);
print '</td></tr>';

// Private note
if (empty($user->societe_id)) {
print '<tr>';
Expand All @@ -1306,7 +1307,7 @@
print $doleditor->Create(1);
print '</td></tr>';
}

print '</table>';

dol_fiche_end();
Expand Down
7 changes: 6 additions & 1 deletion htdocs/expensereport/class/expensereport.class.php
View file
Expand Up @@ -16,6 +16,11 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

/**
* \file htdocs/expensereport/class/expensereport.class.php
* \ingroup expensereport
* \brief File to manage Expense Reports
*/
require_once DOL_DOCUMENT_ROOT .'/core/class/commonobject.class.php';

/**
Expand Down Expand Up @@ -1420,7 +1425,7 @@ public function generateDocument($modele, $outputlangs, $hidedetails=0, $hidedes

return $this->commonGenerateDocument($modelpath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref);
}

/**
* List of types
*
Expand Down
2 changes: 1 addition & 1 deletion htdocs/expensereport/class/expensereportstats.class.php
View file
Expand Up @@ -19,7 +19,7 @@

/**
* \file htdocs/expensereport/class/expensereportstats.class.php
* \ingroup ExpenseReport
* \ingroup expensereport
* \brief Fichier de la classe de gestion des stats des expensereport et notes de frais
*/
include_once DOL_DOCUMENT_ROOT . '/core/class/stats.class.php';
Expand Down
1 change: 1 addition & 0 deletions htdocs/expensereport/export_csv.php
View file
Expand Up @@ -17,6 +17,7 @@

/**
* \file htdocs/expensereport/index.php
* \ingroup expensereport
* \brief Page list of expenses
*/

Expand Down
1 change: 1 addition & 0 deletions htdocs/expensereport/index.php
View file
Expand Up @@ -21,6 +21,7 @@

/**
* \file htdocs/expensereport/index.php
* \ingroup expensereport
* \brief Page list of expenses
*/

Expand Down
2 changes: 1 addition & 1 deletion htdocs/expensereport/info.php
View file
Expand Up @@ -19,7 +19,7 @@

/**
* \file htdocs/expensereport/info.php
* \ingroup trip
* \ingroup expensereport
* \brief Page to show a trip information
*/

Expand Down
1 change: 1 addition & 0 deletions htdocs/expensereport/list.php
View file
Expand Up @@ -21,6 +21,7 @@

/**
* \file htdocs/expensereport/index.php
* \ingroup expensereport
* \brief list of expense reports
*/

Expand Down

0 comments on commit 6e25169

Please sign in to comment.