Show
Ignore:
Timestamp:
04/13/06 05:47:01 (3 years ago)
Author:
jordi
Message:

Added the doxygen documentation builder file in the "doc" directory. I've also wirtten the missing documentation for all files in "src", but not in "src/gtk" a it would be redundant.

Also I've been paranoic on spelling (I'm a very bad spelled) and spell checked all source files, changing some string. Updated the translations.

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • trunk/src/PDFDocument.cxx

    r43 r49  
    3838 
    3939/// 
    40 /// @brief Constructs a new Document object. 
     40/// @brief Constructs a new PDFDocument object. 
    4141/// 
    4242PDFDocument::PDFDocument (): 
     
    4848 
    4949/// 
    50 /// @brief Deletes all dynamically created objects of Document. 
     50/// @brief Deletes all dynamically created objects of PDFDocument. 
    5151/// 
    5252PDFDocument::~PDFDocument () 
     
    5959/// @brief Checks if the document has been loaded. 
    6060/// 
    61 /// @return true if the document has been loaded, false otherwise. 
     61/// @return TRUE if the document has been loaded, FALSE otherwise. 
    6262/// 
    6363gboolean 
     
    6868 
    6969/// 
    70 /// @brief Load a PDF file. 
     70/// @brief Loads a PDF file. 
    7171/// 
    7272/// Tries to open the PDF file @a filename using the password in @a password. 
    7373/// 
    74 /// @param filename The name of the filename to open. 
     74/// @param filename The name of the file name to open. 
    7575/// @param password The password to use to open @a filename. 
    76 /// @param error Locatrion to store the error ocurringm or NULL to ignore  
     76/// @param error Location to store the error occurring or NULL to ignore  
    7777///              errors. 
    7878/// 
    79 /// @return True if the file could be opened, false otherwise. 
     79/// @return TRUE if the file could be opened, FALSE otherwise. 
    8080/// 
    8181gboolean 
     
    8383                    GError **error) 
    8484{ 
    85     g_assert (NULL != filename && "Tried to load a NULL filename"); 
    86  
    87     // The poppler library has a GLOBAL file for parameters. 
     85    g_assert (NULL != filename && "Tried to load a NULL file name"); 
     86 
     87    // The Poppler library has a GLOBAL file for parameters. 
    8888    // If this file isn't loaded then weird error happens. 
    8989    if ( NULL == globalParams ) 
     
    104104    // deleting it will cause trouble when deleting the newDocument. 
    105105 
    106     // Check if the document couldn't be opened sucessfully and why. 
     106    // Check if the document couldn't be opened successfully and why. 
    107107    if ( !newDocument->isOk() ) 
    108108    { 
     
    116116        g_free (errorMessage); 
    117117 
    118         return false; 
     118        return FALSE; 
    119119    } 
    120120    
     
    128128    m_OutputDevice->startDoc (m_Document->getXRef ()); 
    129129 
    130     return true; 
    131 } 
    132  
    133 /// 
    134 /// @brief Read the document's metadata. 
    135 /// 
    136 /// After each successful load of a PDF file, its metadata is read and 
     130    return TRUE; 
     131} 
     132 
     133/// 
     134/// @brief Reads the document's meta data. 
     135/// 
     136/// After each successful load of a PDF file, its meta data is read and 
    137137/// keep in member variables of this class, so a call to get*() function 
    138138/// will return it. 
    139139/// 
     140/// Also resets the rotation degree to 0 and the scale level to 1.0f. 
     141/// 
    140142void 
    141143PDFDocument::loadMetadata (void) 
     
    143145    g_assert (NULL != m_Document && "The document has not been loaded."); 
    144146 
    145     // Retrieve the document's metadata dictionary. 
     147    // Retrieve the document's meta data dictionary. 
    146148    Object dictionary; 
    147149    m_Document->getDocInfo (&dictionary); 
     
    168170    setKeywords (value); 
    169171    g_free (value); 
    170     // Is linearized 
     172    // Is linearised 
    171173    setLinearized (m_Document->isLinearized ()); 
    172174    // Modified date 
     
    206208/// 
    207209/// Retrieves the string value of @a key inside the dictionary @a directory. The 
    208 /// dictionaty must be an Object retrieved by calling Poppler's getDocInfo() 
     210/// dictionary must be an Object retrieved by calling Poppler's getDocInfo() 
    209211/// function. 
    210212/// 
     
    234236            if ( hasUnicodeMarker (value_g) ) 
    235237            { 
    236                 // Convert the string skipping the unicode marker, 
     238                // Convert the string skipping the Unicode marker, 
    237239                // which is 2 bytes long (UTF-16BE). 
    238240                result = g_convert (value_g->getCString () + 2, 
     
    271273/// 
    272274/// Retrieves the string value of @a key inside the dictionary @a directory. The 
    273 /// dictionaty must be an Object retrieved by calling Poppler's getDocInfo() 
     275/// dictionary must be an Object retrieved by calling Poppler's getDocInfo() 
    274276/// function. 
    275277/// 
     
    301303            { 
    302304                // Copy the string skipping the two-bytes long 
    303                 // unicode marker. 
     305                // Unicode marker. 
    304306                dateString = g_convert (value_g->getCString () + 2, 
    305307                                        value_g->getLength () - 2, 
     
    350352 
    351353/// 
    352 /// @brief Checks if a GooString has the unicode marker. 
     354/// @brief Checks if a GooString has the Unicode marker. 
    353355/// 
    354356/// I really don't know, but it seems that some PDF files has UTF-16BE 
     
    356358/// Order Marker), which is 0xfeff for Big Endian and 0xfffe for Little Endian. 
    357359/// 
    358 /// @param string The string to check if has the unicode marker. 
    359 /// 
    360 /// @return true if the GooString has the unicode marker, false otherwise. 
     360/// @param string The string to check if has the Unicode marker. 
     361/// 
     362/// @return TRUE if the GooString has the Unicode marker, FALSE otherwise. 
    361363/// 
    362364gboolean 
     
    368370 
    369371/// 
    370 /// @brief Get the document's page layout. 
     372/// @brief Gets the document's page layout from Poppler's catalog. 
    371373/// 
    372374/// @param pageLayout Is the page layout that Poppler's catalog gives.