testing/054_parblock.cpp

   1 // objective: test the \parblock command
   2 // check: 054__parblock_8cpp.xml
   3
   4 /** @file */
   5
   6 /**
   7  call by target-specific code to manage resources required by the client.
   8
   9  @param[in]  client    ID of client requesting resource.
  10  @param[out] resource  Requested resource
  11  @param[in]  parblock  @parblock This is a test for the \@parblock
  12                        command.
  13
  14                        A list if values for the parblock param:
  15                        - Item 1. This is short one-line description.
  16                        - Item 2. This is a long bullet item;
  17                          sometimes they wrap on multiple lines like this
  18                          one.
  19
  20                        This is the second paragraph description for the
  21                        \@parblock parameter. Always end the text inside
  22                        the \@parblock command with an \@endparblock
  23                        command.
  24                        @endparblock
  25  @param[out] test      This is a test parameter for this function to see if
  26                        it is included in the parameter table
  27  @param[in]  p         @parblock First paragraph of the param description.
  28
  29                        Second paragraph of the param description.
  30                        @endparblock
  31  */
  32 void function(int client,int *resource,int parblock,int *test,int p);