White Cat lighting board

White Cat Lighting Board Documentation

Outils pour utilisateurs

Outils du site


documentation_doxygen_eng

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Both sides previous revision Révision précédente
documentation_doxygen_eng [2014/11/30 21:03]
jody [Functions and Variables]
documentation_doxygen_eng [2014/11/30 21:24] (Version actuelle)
jody [An example might be more relevant]
Ligne 146: Ligne 146:
 /** /**
 * \fn int play(const char* file, long startTime) * \fn int play(const char* file, long startTime)
-* \brief permission to read an audio file from a given moment+* \brief permission to read an audio file from a particular time
 * \param const char* file path of the complete file which must be an audio file(mp3, wave,aiff) * \param const char* file path of the complete file which must be an audio file(mp3, wave,aiff)
-* \param long startTime start of the file in milleseconds+* \param long startTime start of the file in milliseconds
 * \return the number of the file in the playlist or -1 if there was an error reading * \return the number of the file in the playlist or -1 if there was an error reading
 */ */
 int play(const char* file, long startTime) int play(const char* file, long startTime)
 { {
-//fonction ​play+//function ​play
 } }
  
 </​code>​ </​code>​
  
-En C++ at the beginning of all filenames.h ::+En C++ at the beginning of all .h files::
  
 <​code>​ <​code>​
Ligne 195: Ligne 195:
 /*! /*!
 * \file audioplayer.h * \file audioplayer.h
-* \brief Whitecat 0.8.5 modification ​des audio players ​en intégrant la librairie ​Juce. +* \brief Whitecat 0.8.5 modification ​of the audio players ​integrating into the Juce library
 * \author Christophe Guillermait modified by Anton Langhoff * \author Christophe Guillermait modified by Anton Langhoff
 * \version 0.2 * \version 0.2
Ligne 202: Ligne 202:
 */ */
  
-//permet de declarer une nouvelle classe+//permission to declare a new class
 /*! \class AudioPlayer /*! \class AudioPlayer
-* \brief ​crée un player ​audio multidiffusion+* \brief ​create a multitrack ​audio player ​
 * *
 */ */
Ligne 211: Ligne 211:
 { {
  
-/*! \brief ​contructeur d'un player ​audio multipiste +/*! \brief ​constructor of a multitrack ​audio player 
-*  \param nbOut permet de définir le nombres de sortie utilisées par le player, ​par default ​le player ​est stéréo ​+*  \Param nbOut sets the output numbers used by the player, ​by default ​the player ​is stereo ​
 * *
-*/+*/ 
 AudioPlayer(int nbOut=2); AudioPlayer(int nbOut=2);
  
-//pareil pour le destructeur +//same for the destruction 
-/*! \brief ​destructeur du player ​audio multipiste+/*! \brief ​destruction of the multitrack ​player
 * *
 */ */
 ~AudioPlayer() ; ~AudioPlayer() ;
  
-//déclaration de la première fonction+//declaration of the first function
  
 /*! /*!
 * \fn int play(const char* file, long startTime) * \fn int play(const char* file, long startTime)
-* \brief ​permet de lire un fichier ​audio depuis un moment donner +* \brief ​permission to read an audio file from a particular time 
-* \param const char* file chemin du fichier completdoit être un fichier ​audio(mp3, wave,​aiff) +* \param const char* file path to the complete fileMust be an audio file(mp3, wave,​aiff) 
-* \param long startTime ​départ de la lecture du fichier en milliseconde +* \param long startTime ​start of the file in milliseconds 
-* \return ​le numéro du fichier dans la playlist ​ou -1 si il y a eu une erreur de lecture +* \return ​the number of the file in the playlist ​or -1 or if there is an error reading
-*+
 */ */
 void int play(const char* file, long startTime); void int play(const char* file, long startTime);
Ligne 243: Ligne 242:
  
  
-Un tuto plus complet est disponible à cette adresse ​: [[http://​franckh.developpez.com/​tutoriels/​outils/​doxygen/​+A complete tutorial is available at this address: [[http://​franckh.developpez.com/​tutoriels/​outils/​doxygen/​
 ]] ]]
  
documentation_doxygen_eng.txt · Dernière modification: 2014/11/30 21:24 par jody