Commit dea0af5f8c7c0f4368e142ab7523b7c7f041eab4
1 parent
33ef5317
enhance Doxygen information
Showing
1 changed file
with
9 additions
and
4 deletions
src/fits/GFitsHeader.cpp
| @@ -410,6 +410,9 @@ void GFitsHeader::free_members(void) | @@ -410,6 +410,9 @@ void GFitsHeader::free_members(void) | ||
| 410 | * | 410 | * |
| 411 | * @param[in] keyname Name of the header card | 411 | * @param[in] keyname Name of the header card |
| 412 | * | 412 | * |
| 413 | + * @exception GException::fits_key_not_found | ||
| 414 | + * Requested header card was not found in header. | ||
| 415 | + * | ||
| 413 | * Returns a pointer on the header card. | 416 | * Returns a pointer on the header card. |
| 414 | * If card was not found a 'fits_key_not_found' error will be thrown. | 417 | * If card was not found a 'fits_key_not_found' error will be thrown. |
| 415 | ***************************************************************************/ | 418 | ***************************************************************************/ |
| @@ -439,7 +442,9 @@ GFitsHeaderCard* GFitsHeader::card_ptr(const std::string& keyname) | @@ -439,7 +442,9 @@ GFitsHeaderCard* GFitsHeader::card_ptr(const std::string& keyname) | ||
| 439 | /***********************************************************************//** | 442 | /***********************************************************************//** |
| 440 | * @brief Open Header | 443 | * @brief Open Header |
| 441 | * | 444 | * |
| 442 | - * @param fptr Pointer to FITS file from which the header will be loaded | 445 | + * @param[in] fptr Pointer to FITS file from which the header will be loaded |
| 446 | + * | ||
| 447 | + * @exception GException::fits_error FITS error occured. | ||
| 443 | * | 448 | * |
| 444 | * Loads all header cards into memory. Any header cards that existed before | 449 | * Loads all header cards into memory. Any header cards that existed before |
| 445 | * will be dropped. | 450 | * will be dropped. |
| @@ -475,7 +480,9 @@ void GFitsHeader::open(__fitsfile* fptr) | @@ -475,7 +480,9 @@ void GFitsHeader::open(__fitsfile* fptr) | ||
| 475 | /***********************************************************************//** | 480 | /***********************************************************************//** |
| 476 | * @brief Save Header to FITS file | 481 | * @brief Save Header to FITS file |
| 477 | * | 482 | * |
| 478 | - * @param fptr Pointer to FITS file into which the header cards will be saved | 483 | + * @param[in] fptr Pointer to FITS file into which the header cards will be saved |
| 484 | + * | ||
| 485 | + * @exception GException::fits_error FITS error occured. | ||
| 479 | * | 486 | * |
| 480 | * Saves all header cards into HDU. This method does not write the following | 487 | * Saves all header cards into HDU. This method does not write the following |
| 481 | * mandatory keywords to the HDU (those will be writted by methods handling | 488 | * mandatory keywords to the HDU (those will be writted by methods handling |
| @@ -489,7 +496,6 @@ void GFitsHeader::open(__fitsfile* fptr) | @@ -489,7 +496,6 @@ void GFitsHeader::open(__fitsfile* fptr) | ||
| 489 | ***************************************************************************/ | 496 | ***************************************************************************/ |
| 490 | void GFitsHeader::save(__fitsfile* fptr) | 497 | void GFitsHeader::save(__fitsfile* fptr) |
| 491 | { | 498 | { |
| 492 | -//cout << "GFitsHeader::save entry" << endl; | ||
| 493 | // Move to HDU | 499 | // Move to HDU |
| 494 | int status = 0; | 500 | int status = 0; |
| 495 | status = __ffmahd(fptr, (fptr->HDUposition)+1, NULL, &status); | 501 | status = __ffmahd(fptr, (fptr->HDUposition)+1, NULL, &status); |
| @@ -509,7 +515,6 @@ void GFitsHeader::save(__fitsfile* fptr) | @@ -509,7 +515,6 @@ void GFitsHeader::save(__fitsfile* fptr) | ||
| 509 | } | 515 | } |
| 510 | } | 516 | } |
| 511 | 517 | ||
| 512 | -//cout << "GFitsHeader::save exit" << endl; | ||
| 513 | // Return | 518 | // Return |
| 514 | return; | 519 | return; |
| 515 | } | 520 | } |