Item13897: Minor changes to PerlDoc

- Show smells was based upon public/private instead of guest / logged - Fix some typos in Foswiki::App, and organize the headings a bit.
foswiki · Oct 18, 2016 · c442117 · c442117
1 parent e3423f4
commit c442117
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 10 deletions.
diff --git a/core/lib/Foswiki/App.pm b/core/lib/Foswiki/App.pm
@@ -591,7 +591,7 @@ sub handleRequest {
 
 =begin TML
 
---++ ObjectMethod create($className, %initArgs)
+---++ ObjectMethod create($className, %initArgs)
 
 Creates a new object of class =$className=. If the class does =Foswiki::App=
 role then constructor gets called with =app= key pointing to the Foswiki::App
@@ -1915,6 +1915,7 @@ sub popTopicContext {
 
 =begin TML
 
+---++ API Methods - User related
 ---+++ ObjectMethod getDefaultUserName -> $loginName
 Get default user name as defined in the configuration as =DefaultUserLogin=
 
@@ -2172,6 +2173,7 @@ sub isAnAdmin {
 
 =begin TML
 
+---++ API Methods - Group related
 ---+++ ObjectMethod isGroupMember( $group, $id, $options ) -> $boolean
 
 Find out if $id is in the named group.  The expand option controls whether or not nested groups are searched.
@@ -2269,7 +2271,7 @@ sub eachMembership {
 
 =begin TML
 
----+++ eachGroupMember($group) -> $iterator
+---+++ ObjectMethod eachGroupMember($group) -> $iterator
 Get an iterator over all the members of the named group. Returns undef if
 $group is not a valid group.  Nested groups are expanded unless the
 expand option is set to false.
@@ -2310,7 +2312,7 @@ sub eachGroupMember {
 
 =begin TML
 
----+++ addUserToGroup( $id, $group, $create ) -> $boolean
+---+++ ObjectMethod addUserToGroup( $id, $group, $create ) -> $boolean
 
    * $id can be a login name or a WikiName
 
@@ -2332,7 +2334,7 @@ sub addUserToGroup {
 
 =begin TML
 
----+++ removeUserFromGroup( $group, $id ) -> $boolean
+---+++ ObjectMethod removeUserFromGroup( $group, $id ) -> $boolean
 
    * $id can be a login name or a WikiName
 
@@ -2355,6 +2357,7 @@ sub removeUserFromGroup {
 
 =begin TML
 
+---++ API Methods - Web / Topic / Attachment - reading
 ---+++ ObjectMethod checkAccessPermission( $type, $id, $text, $topic, $web, $meta ) -> $boolean
 
 Check access permission for a topic based on the
@@ -2780,7 +2783,7 @@ sub readAttachment {
 
 =begin TML
 
----++ Manipulating
+---++ API Methods - Web / Topic / Attachment - Manipulating
 
 =cut
 
@@ -3789,7 +3792,7 @@ sub writeEvent {
 
 =begin TML
 
----+++ ObjectMethof writeWarning( $text )
+---+++ ObjectMethod writeWarning( $text )
 
 Log a warning that may require admin intervention to the warnings log (=data/warn*.txt=)
    * =$text= - Text to write; timestamp gets added

diff --git a/core/lib/Foswiki/IncludeHandlers/doc.pm b/core/lib/Foswiki/IncludeHandlers/doc.pm
@@ -93,11 +93,11 @@ sub INCLUDE {
                 _With         => $withRx . $paramsRx,
                 _FoswikiClass => $fwClassRx . $paramsRx,
                 (
-                    $publicOnly # Don't even parse FIXME comments if public only mode.
-                    ? ()
-                    : ( _FixmeComment =>
+                    $showSmells # Don't even parse FIXME comments to non-admin users.
+                    ? ( _FixmeComment =>
 '\n\h*?(?<commentLine>#\h*?(?<commentType>SMELL|TODO|FIXME)\b\h*(?<commentText>.+?))(?=\n)'
-                    )
+                      )
+                    : ()
                 ),
             },
         );
@@ -353,6 +353,7 @@ sub _makeCtx {
           . $rxStr . "/\n"
           . Foswiki::Exception::errorStr($@) )
       if $@;
+
     return \%ctxData;
 }