Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/gui/gui_update.cc
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (19 years ago)
-
orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit
- File:
-
- 1 edited
-
orxonox/trunk/src/lib/gui/gui_update.cc (modified) (20 diffs)
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/lib/gui/gui_update.cc
r4774 r4836 33 33 34 34 /** 35 \briefCreates an Update-Frame35 * Creates an Update-Frame 36 36 */ 37 37 GuiUpdate::GuiUpdate() … … 98 98 99 99 /** 100 \briefDestructs the Update-stuff100 * Destructs the Update-stuff 101 101 */ 102 102 GuiUpdate::~GuiUpdate() … … 106 106 107 107 /** 108 \briefchecks if the Folder containing selected File is data.oxd, and if so sets it.109 \param108 * checks if the Folder containing selected File is data.oxd, and if so sets it. 109 * @param 110 110 */ 111 111 bool GuiUpdate::checkDataDir(const char* fileName, void* object) … … 126 126 127 127 /** 128 \briefLook what info we can get from this system128 * Look what info we can get from this system 129 129 */ 130 130 bool GuiUpdate::getSystemInfo() … … 167 167 168 168 /** 169 \briefCreates a window, and all it contains for the Data-update.169 * Creates a window, and all it contains for the Data-update. 170 170 */ 171 171 void GuiUpdate::updateDataWindowCreate() … … 206 206 207 207 /** 208 \returns A Pointer to the Button of the UpdaterDataWindow208 * @returns A Pointer to the Button of the UpdaterDataWindow 209 209 */ 210 210 Button* GuiUpdate::updateDataWindowGetButton() … … 214 214 215 215 /** 216 \briefCreates a window, and all it contains for the Source-update.216 * Creates a window, and all it contains for the Source-update. 217 217 */ 218 218 void GuiUpdate::updateSourceWindowCreate() … … 245 245 246 246 /** 247 \returns A Pointer to the Button of the UpdaterSourceWindow247 * @returns A Pointer to the Button of the UpdaterSourceWindow 248 248 */ 249 249 Button* GuiUpdate::updateSourceWindowGetButton() … … 255 255 #ifdef HAVE_GTK2 256 256 /** 257 \briefupdates the Data of orxonox.258 \param w The widget, that executed this Function.259 \param event The event that trigered this Function.260 \param button The Button, that triggered this event.257 * updates the Data of orxonox. 258 * @param w The widget, that executed this Function. 259 * @param event The event that trigered this Function. 260 * @param button The Button, that triggered this event. 261 261 */ 262 262 gint GuiUpdate::updateDataFunc(GtkWidget* w, GdkEventKey* event, void* info) … … 272 272 273 273 /** 274 \briefupdates the source of orxonox.275 \param w The widget, that executed this Function.276 \param event The event that trigered this Function.277 \param button The Button, that triggered this event.274 * updates the source of orxonox. 275 * @param w The widget, that executed this Function. 276 * @param event The event that trigered this Function. 277 * @param button The Button, that triggered this event. 278 278 */ 279 279 gint GuiUpdate::updateSourceFunc(GtkWidget* w, GdkEventKey* event, void* bar) … … 286 286 287 287 /** 288 \briefThe Function Curl calls to write out the File.289 \param ptr A Pointer to the date to write.290 \param size The size in bytes of one nmemb to write.291 \param nmemb The Count of size to write.292 \param stream Filehandler to write to.288 * The Function Curl calls to write out the File. 289 * @param ptr A Pointer to the date to write. 290 * @param size The size in bytes of one nmemb to write. 291 * @param nmemb The Count of size to write. 292 * @param stream Filehandler to write to. 293 293 */ 294 294 size_t GuiUpdate::curlWriteFunc(void* ptr, size_t size, size_t nmemb, FILE* stream) … … 298 298 299 299 /** 300 \briefThe Function Curl calls to write out the File.301 \param ptr A Pointer to the date to write to.302 \param size The size in bytes of one nmemb to write.303 \param nmemb The Count of size to write.304 \param stream Filehandler to get data from.300 * The Function Curl calls to write out the File. 301 * @param ptr A Pointer to the date to write to. 302 * @param size The size in bytes of one nmemb to write. 303 * @param nmemb The Count of size to write. 304 * @param stream Filehandler to get data from. 305 305 */ 306 306 size_t GuiUpdate::curlReadFunc(void* ptr, size_t size, size_t nmemb, FILE* stream) … … 311 311 312 312 /** 313 \briefAn update Function for the GUI, to show the progress.314 \param Bar th ProgressBar to update315 \param totalSize The total size of the download in bytes.316 \param progress The current Progress of the download in bytes.317 \param upTotal not needed318 \param upProgress not needed313 * An update Function for the GUI, to show the progress. 314 * @param Bar th ProgressBar to update 315 * @param totalSize The total size of the download in bytes. 316 * @param progress The current Progress of the download in bytes. 317 * @param upTotal not needed 318 * @param upProgress not needed 319 319 */ 320 320 int GuiUpdate::curlProgressFunc(ProgressBar* bar, double totalSize, double progress, double upTotal, double upProgress) … … 329 329 330 330 /** 331 \briefThe Curl handle for only one CURL(static).331 * The Curl handle for only one CURL(static). 332 332 */ 333 333 CURL* GuiUpdate::curlHandle = NULL; … … 340 340 341 341 /** 342 \briefInitializes a Download without displaying it.343 \param fileInfo the FileInfo.342 * Initializes a Download without displaying it. 343 * @param fileInfo the FileInfo. 344 344 345 345 !! BE AWARE THIS WILL NOT BE THREADED. !! … … 359 359 char* fileOnNet = new char [strlen(info->webRoot)+strlen(info->fileName)+2]; 360 360 strcpy(fileOnNet, info->webRoot); 361 if(fileOnNet[strlen(fileOnNet)] != '/') //!< \todo windows-shit361 if(fileOnNet[strlen(fileOnNet)] != '/') //!< @todo windows-shit 362 362 strcat(fileOnNet, "/"); 363 363 strcat(fileOnNet, info->fileName); 364 364 char* fileOnDisk = new char [strlen(info->localRoot)+strlen(info->fileName)+2]; 365 365 strcpy(fileOnDisk, info->localRoot); 366 if(fileOnDisk[strlen(fileOnDisk)] != '/') //!< \todo windows-shit366 if(fileOnDisk[strlen(fileOnDisk)] != '/') //!< @todo windows-shit 367 367 strcat(fileOnDisk, "/"); 368 368 strcat(fileOnDisk, info->fileName); … … 387 387 388 388 /** 389 \briefInitializes a Download with some style.390 \param fileInfo the FileInfo.391 \todo release thread-lock.389 * Initializes a Download with some style. 390 * @param fileInfo the FileInfo. 391 @todo release thread-lock. 392 392 393 393 Downloading with a Button that gets a different Name while downloading, and a Bar, that gets to be updated. More to be followed … … 447 447 448 448 /** 449 \briefThe downloading process(either threaded or not).450 \param fileInfo the FileInfo.451 452 \todo Threads get locked, if the cancel button is pressed in to small intervals.449 * The downloading process(either threaded or not). 450 * @param fileInfo the FileInfo. 451 452 @todo Threads get locked, if the cancel button is pressed in to small intervals. 453 453 */ 454 454 void* GuiUpdate::downloadThread(void* fileInfo) … … 459 459 460 460 /** 461 \briefFinishes a downloading process.462 \param fileInfo the FileInfo.461 * Finishes a downloading process. 462 * @param fileInfo the FileInfo. 463 463 */ 464 464 void* GuiUpdate::downloadThreadFinished(void* fileInfo) … … 485 485 #ifdef HAVE_GTK2 486 486 /** 487 \briefcanceles a downloading session.488 \param w The widget, that executed this Function.489 \param event The event that trigered this Function.490 \param bar The Bar, that triggered this event.491 492 \todo canceling a session in non-threaded mode.487 * canceles a downloading session. 488 * @param w The widget, that executed this Function. 489 * @param event The event that trigered this Function. 490 * @param bar The Bar, that triggered this event. 491 492 @todo canceling a session in non-threaded mode. 493 493 */ 494 494 gint GuiUpdate::cancelDownload(GtkWidget* w, GdkEventKey* event, void* bar)
Note: See TracChangeset
for help on using the changeset viewer.
