Databases
StackOverflow2013
Postsdbo
PO
 

Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>If it makes it clear for the documentation, then leave it in, but it isn't strictly necessary. It's an entirely subjective decision.</p> <p>Personally, I would leave it out.</p> <p><strong>EDIT</strong><br> I stand corrected. After a little googling, the <a href="http://en.wikipedia.org/wiki/PHPDoc" rel="noreferrer">wikipedia page</a> says:</p> <blockquote> <p>@return [type description] This tag <strong>should not be used</strong> for constructors or methods defined with a void return type.</p> </blockquote> <p>The phpdoc.org website says:</p> <blockquote> <p>@return datatype description<br> @return datatype1|datatype2 description</p> <p>The @return tag is used to document the return value of functions or methods. @returns is an alias for @return to support tag formats of other automatic documentors</p> <p><strong>The datatype should be a valid PHP type</strong> (int, string, bool, etc), a class name for the type of object returned, or simply "mixed". If you want to explicitly show multiple possible return types, list them pipe-delimited without spaces (e.g. "@return int|string"). If a class name is used as the datatype in the @return tag, phpDocumentor will automatically create a link to that class's documentation. In addition, if a function returns multiple possible values, separate them using the | character, and phpDocumentor will parse out any class names in the return value. phpDocumentor will display the optional description unmodified.</p> </blockquote> <p>Sooo... Based on that, I would say leave out the void. It's non-standard, at least.</p>
    singulars
    1. This table or related slice is empty.
    1. POPHPDoc: @return void necessary?
      singulars
      1. PTQuestion
    1. PTAnswer
    1. USSebastian Zartner
    1. USJonathan Fingland
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. POPHPDoc: @return void necessary?
      singulars
      1. PTQuestion
    1. This table or related slice is empty.
    1. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTAcceptedByOriginator
    3. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    1. CODoes adding it even do anything? I believe in PHPDoc if you don't document a return type it automatically assumes `void` and puts it into the method signature in the docs.
      singulars
      1. PO
      1. USMarc W
    2. CO@Marc W: see my edit. not only is it not necessary, it is not supposed to be used.
      singulars
      1. PO
      1. USJonathan Fingland
    3. COMight have changed since 2010 but currently phpdoc.org says: "functions and methods without a `return` value, the @return tag MAY be omitted here, in which case @return void is implied."
      singulars
      1. PO
      1. USTFennis
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload