PHP API::inlineDocumentation Exemples

inlineDocumentation() public méthode

Display the API Documentation in Html (parsed from markdown)

public inlineDocumentation ( $file )
$file		string relative path of documentation file

Exemple #1

Fichier : apirest.class.php Projet : glpi-project/glpi

 /**
  * Display the APIRest Documentation in Html (parsed from markdown)
  *
  * @param $file    string   relative path of documentation file (default 'apirest.md')
  **/
 public function inlineDocumentation($file = "apirest.md")
 {
     global $CFG_GLPI;
     if ($this->format == "html") {
         parent::inlineDocumentation($file);
     } else {
         if ($this->format == "json") {
             echo file_get_contents(GLPI_ROOT . '/' . $file);
         }
     }
 }