mirror/Part-DB.Part-DB-server
1
0
Fork 1
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-06-20 17:15:51 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Removed @warning and @note tags used by doxygen before.

Browse source 
The Annotation readers of Symfony and Doctrine does not like them...
This commit is contained in:
Jan Böhmer 2019-03-05 14:15:18 +01:00
parent cb10b31938
commit af5a7f8986
7 changed files with 18 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/Entity/Footprint.php
View file

@ -107,7 +107,7 @@ class Footprint extends PartsContainingDBElement
* This method is used to get all footprints with broken filename
* (Footprint::get_broken_filename_footprints()).
*
* @note An empty filename is a valid filename.
* An empty filename is a valid filename.
*
* @return boolean @li true if file exists or filename is empty
* @li false if there is no file with this filename
@ -127,7 +127,7 @@ class Footprint extends PartsContainingDBElement
* This method is used to get all footprints with broken 3d filename
* (Footprint::get_broken_3d_filename_footprints()).
*
* @note An empty filename is a valid filename.
* An empty filename is a valid filename.
*
* @return boolean @li true if file exists or filename is empty
* @li false if there is no file with this filename
@ -159,20 +159,20 @@ class Footprint extends PartsContainingDBElement
/**
* Change the filename of this footprint
*
* @note The filename won't be checked if it is valid.
* The filename won't be checked if it is valid.
* It's not really a Problem if there is no such file...
* (For this purpose we have the method Footprint::get_broken_filename_footprints())
*
* @param string $new_filename @li the new filename (absolute path from filesystem root, as a UNIX path [only slashes!] !! )
* @li see also lib.functions.php::to_unix_path()
*
* @warning It's really important that you pass the whole (UNIX) path from filesystem root!
* It's really important that you pass the whole (UNIX) path from filesystem root!
* If the file is located in the base directory of Part-DB, the base path
* will be automatically replaced with a placeholder before write it in the database.
* This way, the filenames are still correct if the installation directory
* of Part-DB is moved.
*
* @note The path-replacing will be done in Footprint::check_values_validity(), not here.
* The path-replacing will be done in Footprint::check_values_validity(), not here.
*
* @throws Exception if there was an error
*/

2
src/Entity/NamedDBElement.php
View file

@ -95,7 +95,7 @@ abstract class NamedDBElement extends DBElement
/**
* Change the name of this element
*
* @note Spaces at the begin and at the end of the string will be removed
* Spaces at the begin and at the end of the string will be removed
* automatically in NamedDBElement::check_values_validity().
* So you don't have to do this yourself.
*

6
src/Entity/Part.php
View file

@ -243,7 +243,7 @@ class Part extends AttachmentContainingDBElement
/**
* Get if this part is obsolete
*
* @note A Part is marked as "obsolete" if all their orderdetails are marked as "obsolete".
* A Part is marked as "obsolete" if all their orderdetails are marked as "obsolete".
* If a part has no orderdetails, the part isn't marked as obsolete.
*
* @return boolean @li true if this part is obsolete
@ -598,7 +598,7 @@ class Part extends AttachmentContainingDBElement
* @return array all prices as an array of strings (if "$delimeter == NULL" & "$float_array == false")
* @return string all prices as a string, delimeted by $delimeter (if $delimeter is a string)
*
* @warning If there are orderdetails without prices, for these orderdetails there
* If there are orderdetails without prices, for these orderdetails there
* will be a "NULL" in the returned float array (or a "-" in the string array)!!
* (This is needed for the HTML output, if there are all orderdetails and prices listed.)
*
@ -968,7 +968,7 @@ class Part extends AttachmentContainingDBElement
/**
* Set the ID of the category
*
* @note Every part must have a valid category (in contrast to the
* Every part must have a valid category (in contrast to the
* attributes "footprint", "storelocation", ...)!
*
* @param integer $new_category_id the ID of the category

4
src/Entity/Pricedetail.php
View file

@ -82,7 +82,7 @@ class Pricedetail extends DBElement
* @param integer $multiplier The returned price (float or string) will be multiplied
* with this multiplier.
*
* @note You will get the price for $multiplier parts. If you want the price which is stored
* You will get the price for $multiplier parts. If you want the price which is stored
* in the database, you have to pass the "price_related_quantity" count as $multiplier.
*
* @return float the price as a float number (if "$as_money_string == false")
@ -142,7 +142,7 @@ class Pricedetail extends DBElement
*
* @param float $new_price the new price as a float number
*
* @warning @li This is the price for "price_related_quantity" parts!!
* @li This is the price for "price_related_quantity" parts!!
* @li Example: if "price_related_quantity" is '10',
* you have to set here the price for 10 parts!
*/

8
src/Entity/Storelocation.php
View file

@ -44,8 +44,8 @@ class Storelocation extends PartsContainingDBElement
/**
* Get the "is full" attribute
*
* @note "is_full == true" means that there is no more space in this storelocation.
* @note This attribute is only for information, it has no effect.
* "is_full == true" means that there is no more space in this storelocation.
* This attribute is only for information, it has no effect.
*
* @return boolean @li true if the storelocation is full
* @li false if the storelocation isn't full
@ -64,8 +64,8 @@ class Storelocation extends PartsContainingDBElement
/**
* Change the "is full" attribute of this storelocation
*
* @note "is_full" = true means that there is no more space in this storelocation.
* @note This attribute is only for information, it has no effect.
* "is_full" = true means that there is no more space in this storelocation.
* This attribute is only for information, it has no effect.
*
* @param boolean $new_is_full @li true means that the storelocation is full
* @li false means that the storelocation isn't full

2
src/Entity/StructuralDBElement.php
View file

@ -151,7 +151,7 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
/**
* Get the level
*
* @note The level of the root node is -1.
* The level of the root node is -1.
*
* @return integer the level of this element (zero means a most top element
* [a subelement of the root node])

4
templates/show_part_info.html.twig
View file

@ -198,7 +198,7 @@
<div class="form-group">
<label>{% trans %}createdAt{% endtrans %}:</label>
<p>{{ part.datetimeAdded | date}}
<p>{{ part.addedDate | date}}
{#{if !empty($creation_user)} {% trans %}by{% endtrans %}
{if $can_visit_user}
<a href="{$relative_path}user_info.php?uid={$creation_user_id}">{$creation_user}</a>
@ -213,7 +213,7 @@
<div class="form-group">
<label>{% trans %}lastModified{% endtrans %}:</label>
<p>{{ part.addedDate | date }}
<p>{{ part.lastModified | date }}
{# {if !empty($last_modified_user)} {% trans %}by{% endtrans %}
{if $can_visit_user}
<a href="{$relative_path}user_info.php?uid={$last_modified_user_id}">{$last_modified_user}</a>