From 9f1c105167c1017c83ec2c4f9d7a650a1ec44baa Mon Sep 17 00:00:00 2001 From: Chris Date: Sat, 10 Sep 2016 20:49:22 +0100 Subject: [PATCH] Tweak documentation for clarity and formatting --- modules/ORB/System/Entity.pm | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/modules/ORB/System/Entity.pm b/modules/ORB/System/Entity.pm index dc910c5..87e3c48 100644 --- a/modules/ORB/System/Entity.pm +++ b/modules/ORB/System/Entity.pm @@ -1,5 +1,5 @@ ## @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> # @@ -17,19 +17,29 @@ # along with this program. If not, see . ## @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 # object in the system, typically things like ingredients, prep # memthods, recipe types and states. # # Tables for entities must have a minimum of the following fields: # -# - `id`: unsigned int or larger, auto incremement -# - `name`: varchar ot text, utf8_unicode_ci charset recommended -# - `refcount`: unsigned int recommended -# +# name | type, max size | contents/notes +# ------------|----------------|-------------------------------------------------------------- +# 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; +# Current uses of this module: +# +# - ingredients +# - preparation methods +# - states +# - tags +# - types +# - units + use strict; use parent qw(Webperl::SystemModule); use v5.14; @@ -224,6 +234,7 @@ sub remove_relation { return defined($result); } + # ============================================================================ # Reference counting