ok, thanks.  I had a look at doxygen now so I have a better handle on its basic requirements.  I can see its utility.
d.

----------------------------------------
From: "Alec Smecher" <notifications@github.com>
Sent: Monday, August 12, 2013 11:52 AM
To: "pkp/ojs" <ojs@noreply.github.com>
Cc: "Damion Dooley" <damion@learningpoint.ca>
Subject: Re: [ojs] added xmlMarkup plugin (#89)

In plugins/xmlMarkup/MarkupPlugin.inc.php: 

> +			 > +			$this->_setSuppFileId($suppFile, $articleFilePath, $articleFileManager);  > +			 > +			// Submit the article to the pdfx server > +			$this->_submitURL($articleId); > + > +		} > +		 > +		return false; //or true if for some reason we'd want to cancel the import of the uploaded file into OJS. > +	} > + > + > +	/** > +	 *  > +	 * @param $params = array(&$article); > +	 hookName = e.g. SectionEditorAction::uploadCopyeditVersion  

OK; it also ought to be valid doxygen self-documentaiton, hence the @param tags that are usually used. (We're a long way from warning-free doxygen generation, but would like to improve...)  

-
Reply to this email directly or view it on GitHub.