From b8e97d7c28ad6f168e9314dab3c7651365b1c71c Mon Sep 17 00:00:00 2001 From: Matthias Melcher Date: Sat, 23 Jun 2018 20:50:22 +0000 Subject: Doxygen only: fixed all block comments starting with an asterisk to space-only, fixed doxygen keywords prepended with @ to use a backward slash instead. No code was changed. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12970 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- src/Fl_Paged_Device.cxx | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) (limited to 'src/Fl_Paged_Device.cxx') diff --git a/src/Fl_Paged_Device.cxx b/src/Fl_Paged_Device.cxx index 68b71f565..cc61f4cc0 100644 --- a/src/Fl_Paged_Device.cxx +++ b/src/Fl_Paged_Device.cxx @@ -26,69 +26,69 @@ /** - @brief Begins a print job. + \brief Begins a print job. - @param[in] pagecount the total number of pages of the job (or 0 if you don't know the number of pages) - @param[out] frompage if non-null, *frompage is set to the first page the user wants printed - @param[out] topage if non-null, *topage is set to the last page the user wants printed - @return 0 if OK, non-zero if any error + \param[in] pagecount the total number of pages of the job (or 0 if you don't know the number of pages) + \param[out] frompage if non-null, *frompage is set to the first page the user wants printed + \param[out] topage if non-null, *topage is set to the last page the user wants printed + \return 0 if OK, non-zero if any error */ int Fl_Paged_Device::begin_job(int pagecount, int *frompage, int *topage) {return 1;} /** - @brief Begins a new printed page + \brief Begins a new printed page The page coordinates are initially in points, i.e., 1/72 inch, and with origin at the top left of the printable page area. - @return 0 if OK, non-zero if any error + \return 0 if OK, non-zero if any error */ int Fl_Paged_Device::begin_page (void) {return 1;} /** - @brief Computes the dimensions of margins that lie between the printable page area and + \brief Computes the dimensions of margins that lie between the printable page area and the full page. Values are in the same unit as that used by FLTK drawing functions. They are changed by scale() calls. - @param[out] left If non-null, *left is set to the left margin size. - @param[out] top If non-null, *top is set to the top margin size. - @param[out] right If non-null, *right is set to the right margin size. - @param[out] bottom If non-null, *bottom is set to the bottom margin size. + \param[out] left If non-null, *left is set to the left margin size. + \param[out] top If non-null, *top is set to the top margin size. + \param[out] right If non-null, *right is set to the right margin size. + \param[out] bottom If non-null, *bottom is set to the bottom margin size. */ void Fl_Paged_Device::margins(int *left, int *top, int *right, int *bottom) {} /** - @brief Changes the scaling of page coordinates. + \brief Changes the scaling of page coordinates. This function also resets the origin of graphics functions at top left of printable page area. After a scale() call, do a printable_rect() call to get the new dimensions of the printable page area. Successive scale() calls don't combine their effects. - @param scale_x Horizontal dimensions of plot are multiplied by this quantity. - @param scale_y Same as above, vertically. + \param scale_x Horizontal dimensions of plot are multiplied by this quantity. + \param scale_y Same as above, vertically. The value 0. is equivalent to setting \p scale_y = \p scale_x. Thus, scale(factor); is equivalent to scale(factor, factor); */ void Fl_Paged_Device::scale (float scale_x, float scale_y) {} /** - @brief Rotates the graphics operations relatively to paper. + \brief Rotates the graphics operations relatively to paper. The rotation is centered on the current graphics origin. Successive rotate() calls don't combine their effects. - @param angle Rotation angle in counter-clockwise degrees. + \param angle Rotation angle in counter-clockwise degrees. */ void Fl_Paged_Device::rotate(float angle) {} /** - @brief To be called at the end of each page. + \brief To be called at the end of each page. - @return 0 if OK, non-zero if any error. + \return 0 if OK, non-zero if any error. */ int Fl_Paged_Device::end_page (void) {return 1;} /** - @brief To be called at the end of a print job. + \brief To be called at the end of a print job. */ void Fl_Paged_Device::end_job (void) {} -- cgit v1.2.3