OJS OCS OMP OHS

You are viewing the PKP Support Forum | PKP Home Wiki



[PATCH] Function docs for constructor of MailArticleTemplate

OJS development discussion, enhancement requests, third-party patches and plug-ins.

Moderators: jmacgreg, btbell, michael, bdgregg, barbarah, asmecher

Forum rules
The Public Knowledge Project Support Forum is moving to http://forum.pkp.sfu.ca

This forum will be maintained permanently as an archived historical resource, but all new questions should be added to the new forum. Questions will no longer be monitored on this old forum after March 30, 2015.

[PATCH] Function docs for constructor of MailArticleTemplate

Postby rmichael » Wed Nov 12, 2008 1:35 pm

Here's a tiny one liner to fix the docs in the constructor of MailArticleTemplate. It should be the same as the parent, MailTemplate. It's of interest to me because otherwise, the doxygen generated docs are wrong and I use them quite a bit. Also, it's misleading because it's not an int, it's a string .. the template name!

Code: Select all
--- ojs-2.2.2_clean/classes/mail/ArticleMailTemplate.inc.php    2008-06-30 21:16:10.000000000 -0400
+++ ojs-2.2.2/classes/mail/ArticleMailTemplate.inc.php  2008-11-12 15:18:50.000000000 -0500
@@ -40,7 +40,7 @@
        /**
         * Constructor.
         * @param $article object
-        * @param $emailType int optional
+        * @param $emailKey string unique identifier for the template
         * @param $locale string optional
         * @param $enableAttachments boolean optional
         * @param $journal object optional
rmichael
 
Posts: 113
Joined: Fri Mar 30, 2007 3:32 pm

Re: [PATCH] Function docs for constructor of MailArticleTemplate

Postby mcrider » Wed Nov 12, 2008 2:21 pm

Hi Richard,

Thanks, I'll make the change in CVS. Glad to hear people are using the Doxygen docs!

Cheers,
Matt
mcrider
 
Posts: 952
Joined: Mon May 05, 2008 10:29 am
Location: Vancouver, BC


Return to OJS Development

Who is online

Users browsing this forum: Bing [Bot] and 3 guests