Skip to Navigation
OTRS 2.2 - Developer Manual
PrevChapter 2. Coding Style GuideNext

2.9. Perldoc

Every function which could be used outside of its package must have a perldoc. It should look like the following example. 


    =item SystemTime2TimeStamp()

    returns a time stamp in "yyyy-mm-dd 23:59:59" format.

        my $TimeStamp = $TimeObject->SystemTime2TimeStamp(
            SystemTime => $SystemTime,
        );

    If you need the short format "23:59:59" if the date is today (if needed).

        my $TimeStamp = $TimeObject->SystemTime2TimeStamp(
            SystemTime => $SystemTime,
            Type => 'Short',
        );
    =cut

PrevHomeNext
Using of the MainObjectUpLength of lines