This repository has been archived by the owner on May 10, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
FieldData.pm
executable file
·116 lines (86 loc) · 2.63 KB
/
FieldData.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
package VisDoc::FieldData;
use strict;
use warnings;
use overload ( '""' => \&as_string );
=pod
Used for:
fields: @return, @since, @see, {@link ...}, {@linkplain ...}
param fields: @param name : description
=cut
our $TYPE = {
FIELD => ( 1 << 1 ),
PARAM => ( 1 << 2 ),
};
=pod
=cut
sub new {
my ( $class, $inName, $inValue, $inType ) = @_;
my $this = {
name => $inName,
value => $inValue || '', # value string
type => $inType || $TYPE->{FIELD},
};
bless $this, $class;
return $this;
}
=pod
=cut
sub getValue {
my ($this) = @_;
return $this->{value};
}
=pod
Creates a copy.
=cut
sub copy {
my ($this) = @_;
my $newField =
VisDoc::FieldData->new( $this->{name}, $this->{value}, $this->{type} );
return $newField;
}
=pod
=cut
sub as_string {
my ($this) = @_;
my $str = 'FieldData:';
$str .= "\n\t name=$this->{name}" if $this->{name};
$str .= "\n\t value=$this->{value}" if $this->{value};
$str .= "\n\t type=" . typeString( $this->{type} ) if $this->{type};
$str .= "\n";
return $str;
}
=pod
StaticMethod typeString($typeNum) -> $typeString
=cut
sub typeString {
my ($inType) = @_;
my @type;
push( @type, 'FIELD' ) if ( $inType & $TYPE->{FIELD} );
push( @type, 'PARAM' ) if ( $inType & $TYPE->{PARAM} );
return join( ";", @type );
}
1;
# VisDoc - Code documentation generator, http://visdoc.org
# This software is licensed under the MIT License
#
# The MIT License
#
# Copyright (c) 2010-2011 Arthur Clemens, VisDoc contributors
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.