Chris/ORB
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Tweak documentation for clarity and formatting

Browse Source
This commit is contained in:
Chris 2016-09-10 20:49:22 +01:00
parent b92f2b013e
commit 9f1c105167
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
modules/ORB/System/Entity.pm
View File

@ -1,5 +1,5 @@
## @file ## @file
# This file contains the implementation of the Entity base class. # This file contains the implementation of the Entity model class.
# #
# @author Chris Page <chris@starforge.co.uk> # @author Chris Page <chris@starforge.co.uk>
# #
@ -17,19 +17,29 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
## @class Entity ## @class Entity
# This is a base class for entities in the system, providing common # This is a model class for entities in the system, providing common
# features for all of the entities. Entities are any simple named # features for all of the entities. Entities are any simple named
# object in the system, typically things like ingredients, prep # object in the system, typically things like ingredients, prep
# memthods, recipe types and states. # memthods, recipe types and states.
# #
# Tables for entities must have a minimum of the following fields: # Tables for entities must have a minimum of the following fields:
# #
# - `id`: unsigned int or larger, auto incremement # name | type, max size | contents/notes
# - `name`: varchar ot text, utf8_unicode_ci charset recommended # ------------|----------------|--------------------------------------------------------------
# - `refcount`: unsigned int recommended # id | unsigned int | The ID of the entity; ensure auto incremement
# # name | varchar | Entity name, size depends on entity, utf8_unicode_ci charset recommended
# refcount | unsigned int | How many uses of this are there?
package ORB::System::Entity; package ORB::System::Entity;
# Current uses of this module:
#
# - ingredients
# - preparation methods
# - states
# - tags
# - types
# - units
use strict; use strict;
use parent qw(Webperl::SystemModule); use parent qw(Webperl::SystemModule);
use v5.14; use v5.14;
@ -224,6 +234,7 @@ sub remove_relation {
return defined($result); return defined($result);
} }
# ============================================================================ # ============================================================================
# Reference counting # Reference counting