Item9905: update docco for calling convention of MACRO's, we now pass…

… topicObjects

git-svn-id: http://svn.foswiki.org/trunk@9757 0b4bb1d4-4e5a-0410-9cc4-b2b747904278

EmptyPlugin/lib/Foswiki/Plugins/EmptyPlugin.pm

@@ -167,16 +167,15 @@ sub initPlugin {
 # The function used to handle the %EXAMPLETAG{...}% macro
 # You would have one of these for each macro you want to process.
 #sub _EXAMPLETAG {
-#    my($session, $params, $theTopic, $theWeb) = @_;
+#    my($session, $params, $topicObject) = @_;
 #    # $session  - a reference to the Foswiki session object
 #    #             (you probably won't need it, but documented in Foswiki.pm)
 #    # $params=  - a reference to a Foswiki::Attrs object containing 
 #    #             parameters.
 #    #             This can be used as a simple hash that maps parameter names
 #    #             to values, with _DEFAULT being the name for the default
 #    #             (unnamed) parameter.
-#    # $theTopic - name of the topic in the query
-#    # $theWeb   - name of the web in the query
+#    # $topicObject - a reference to a Foswiki::Meta object containing the topic the macro is being rendered in
 #    # Return: the result of processing the macro. This will replace the
 #    # macro call in the final text.
 #

core/lib/Foswiki.pm

@@ -2986,8 +2986,8 @@ sub _processMacros {
 # Handle expansion of a tag during topic rendering
 # $tag is the tag name
 # $args is the bit in the {} (if there are any)
-# $topic and $web should be passed for dynamic tags (not needed for
-# session or constant tags
+# $topicObject should be passed for dynamic tags (not needed for
+# session or constant tags)
 sub _expandMacroOnTopicRendering {
     my ( $this, $tag, $args, $topicObject ) = @_;