dos o más tipos de datos en @param PHPdoc

Question

bien tengo este phpdoc encima de mi método de clase

/** 
* this a function that translates the text 
* @param string|boolean $lang if string the string given in the parameter will be the language code that will represent the language desired, if true, this will translate based on the website's current language, if false will not translate. 
*/ 

ahora mi problema es, ¿cómo puedo definir el tipo de datos de la $lang que puede aceptar tanto la cadena y SÓLO booleano.

En otras documentaciones vi mixed pero no se refleja correctamente en mi Eclipse IDE con PDT.

Mi pregunta es ¿cuál es el manera estándar en cómo puedo mostrar que un determinado @param es posible aceptar dos o más tipos de datos de tipo.

NOTA: el phpdoc que he dado es una documentación existente de la aplicación en la que estoy trabajando ahora. Bueno, estoy asignado para documentar todo bien.

Answer 1

Lo has hecho bien. El PHPDoc reference brinda estas dos opciones para parámetros que pueden ser múltiples tipos de datos (énfasis mío).

El tipo de datos debe ser un tipo válido PHP (int, string, int, etc), un nombre clase para el tipo de objeto, o simplemente "mixta". Además, puede enumerar múltiples tipos de datos para un único parámetro delimitándolos con el conducto (por ejemplo, "@param int | cadena $ p1").