Zikula Community

• **unknown user**
  
  

  • Rank: Registered User
  • Registered: Mar 16, 2002
  • Last visit: Oct 21, 2009
  • Posts: 11

  Posted: Aug 15, 2006 - 05:06 AM

  Hi -
  
  I've been documenting a set of API compliant PN modules in the phpDocumentor style as I've developed them, but the generated documentation doesn't look too good because of the way arguments are passed to functions in Postnuke as one associative array.
  
  Basicly I have something like:
  
  

  Code

  /**
   * @param   string   A long string
   * @param   array    An array
   * @return  array
   */
  function MyModule_user_func($args) {
      // ...
  }

  
  
  And the generated documentation looks like:
  
  

  Code

  array   MyModule_user_func(string $args, array 1)
  
      * array 1: An array
      * string $args: A long string

  
  
  I think the wrong arguments order and naming is quite misleading - did anyone experience this problem, and maybe even fixed/hacked it?
  
  
  Thanks in advance!
  
  
  Best regards, Jonas Delfs
  
  
  
  edited by: jonasdelfs, Aug 15, 2006 - 05:07 PM

  • 
  •  
• markwest
  
  

  • Rank: Team Member
  • Registered: Mar 18, 2002
  • Last visit: Oct 21, 2009
  • Posts: 6606

  Posted: Aug 15, 2006 - 05:14 AM

  The way we do it with the core code is as follows - using an example from the admin module
  
  

  Code

  /**
   * create an admin category
   *
   * @author Mark West
   * @param string $args['catname'] name of the category
   * @param string $args['description'] description of the category
   * @return mixed admin category ID on success, false on failure
   */

  
  
  -Mark
  
  --
  Visit My homepage and Zikula themes.

  • 
  •  
•  
•  

Users on-line

• internetking

This list is based on users active over the last 60 minutes.