Add some more documentation

Doxyfile.lib

@@ -1243,7 +1243,7 @@ SEARCH_INCLUDES        = YES
 # contain include files that are not input files but should be processed by
 # the preprocessor.
 
-INCLUDE_PATH           =
+INCLUDE_PATH           = include
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 # patterns (like *.h and *.hpp) to filter out the header-files in the

include/wkhtmltox/image.h

@@ -49,8 +49,8 @@ CAPI void wkhtmltoimage_set_phase_changed_callback(wkhtmltoimage_converter * con
 CAPI void wkhtmltoimage_set_progress_changed_callback(wkhtmltoimage_converter * converter, wkhtmltoimage_int_callback cb);
 CAPI void wkhtmltoimage_set_finished_callback(wkhtmltoimage_converter * converter, wkhtmltoimage_int_callback cb);
 CAPI void wkhtmltoimage_begin_convertion(wkhtmltoimage_converter * converter);
-CAPI int wkhtmltoimage_convert(wkhtmltoimage_converter * converter);
-CAPI void wkhtmltoimage_cancel(wkhtmltoimage_converter * converter);
+/* CAPI int wkhtmltoimage_convert(wkhtmltoimage_converter * converter); */
+/* CAPI void wkhtmltoimage_cancel(wkhtmltoimage_converter * converter); */
 
 CAPI int wkhtmltoimage_current_phase(wkhtmltoimage_converter * converter);
 CAPI int wkhtmltoimage_phase_count(wkhtmltoimage_converter * converter);

include/wkhtmltox/pdf.h

@@ -55,9 +55,9 @@ CAPI void wkhtmltopdf_set_error_callback(wkhtmltopdf_converter * converter, wkht
 CAPI void wkhtmltopdf_set_phase_changed_callback(wkhtmltopdf_converter * converter, wkhtmltopdf_void_callback cb);
 CAPI void wkhtmltopdf_set_progress_changed_callback(wkhtmltopdf_converter * converter, wkhtmltopdf_int_callback cb);
 CAPI void wkhtmltopdf_set_finished_callback(wkhtmltopdf_converter * converter, wkhtmltopdf_int_callback cb);
-CAPI void wkhtmltopdf_begin_convertion(wkhtmltopdf_converter * converter);
+/* CAPI void wkhtmltopdf_begin_convertion(wkhtmltopdf_converter * converter); */
+/* CAPI void wkhtmltopdf_cancel(wkhtmltopdf_converter * converter); */
 CAPI int wkhtmltopdf_convert(wkhtmltopdf_converter * converter);
-CAPI void wkhtmltopdf_cancel(wkhtmltopdf_converter * converter);
 CAPI void wkhtmltopdf_add_resource(
 	wkhtmltopdf_converter * converter, wkhtmltopdf_object_settings * setting, const char * data);
 

include/wkhtmltox/utilities.hh

@@ -42,6 +42,6 @@ public slots:
 };
 
 DLL_PUBLIC int handleError(bool success, int errorCode);
-#endif //__UTILITIES_HH__
 
 #include <wkhtmltox/dllend.inc>
+#endif //__UTILITIES_HH__

src/lib/image.h

@@ -33,7 +33,7 @@ typedef void (*wkhtmltoimage_str_callback)(wkhtmltoimage_converter * converter,
 typedef void (*wkhtmltoimage_int_callback)(wkhtmltoimage_converter * converter, const int val);
 typedef void (*wkhtmltoimage_void_callback)(wkhtmltoimage_converter * converter);
 
-CAPI int wkhtmltoimage_init(int useGraphics);
+CAPI int wkhtmltoimage_init(int use_graphics);
 CAPI int wkhtmltoimage_deinit();
 CAPI int wkhtmltoimage_extended_qt();
 
@@ -51,8 +51,8 @@ CAPI void wkhtmltoimage_set_phase_changed_callback(wkhtmltoimage_converter * con
 CAPI void wkhtmltoimage_set_progress_changed_callback(wkhtmltoimage_converter * converter, wkhtmltoimage_int_callback cb);
 CAPI void wkhtmltoimage_set_finished_callback(wkhtmltoimage_converter * converter, wkhtmltoimage_int_callback cb);
 CAPI void wkhtmltoimage_begin_convertion(wkhtmltoimage_converter * converter);
-CAPI int wkhtmltoimage_convert(wkhtmltoimage_converter * converter);
-CAPI void wkhtmltoimage_cancel(wkhtmltoimage_converter * converter);
+/* CAPI int wkhtmltoimage_convert(wkhtmltoimage_converter * converter); */
+/* CAPI void wkhtmltoimage_cancel(wkhtmltoimage_converter * converter); */
 
 CAPI int wkhtmltoimage_current_phase(wkhtmltoimage_converter * converter);
 CAPI int wkhtmltoimage_phase_count(wkhtmltoimage_converter * converter);

src/lib/image_c_bindings.cc

@@ -59,8 +59,8 @@ MyImageConverter::~MyImageConverter() {
 	delete globalSettings;
 }
 
-CAPI int wkhtmltoimage_init(int useGraphics) {
-	return wkhtmltopdf_init(useGraphics);
+CAPI int wkhtmltoimage_init(int use_graphics) {
+	return wkhtmltopdf_init(use_graphics);
 }
 
 CAPI int wkhtmltoimage_deinit() {

src/lib/pdf.h

@@ -36,7 +36,7 @@ typedef void (*wkhtmltopdf_str_callback)(wkhtmltopdf_converter * converter, cons
 typedef void (*wkhtmltopdf_int_callback)(wkhtmltopdf_converter * converter, const int val);
 typedef void (*wkhtmltopdf_void_callback)(wkhtmltopdf_converter * converter);
 
-CAPI int wkhtmltopdf_init(int useGraphics);
+CAPI int wkhtmltopdf_init(int use_graphics);
 CAPI int wkhtmltopdf_deinit();
 CAPI int wkhtmltopdf_extended_qt();
 
@@ -57,9 +57,9 @@ CAPI void wkhtmltopdf_set_error_callback(wkhtmltopdf_converter * converter, wkht
 CAPI void wkhtmltopdf_set_phase_changed_callback(wkhtmltopdf_converter * converter, wkhtmltopdf_void_callback cb);
 CAPI void wkhtmltopdf_set_progress_changed_callback(wkhtmltopdf_converter * converter, wkhtmltopdf_int_callback cb);
 CAPI void wkhtmltopdf_set_finished_callback(wkhtmltopdf_converter * converter, wkhtmltopdf_int_callback cb);
-CAPI void wkhtmltopdf_begin_convertion(wkhtmltopdf_converter * converter);
+/* CAPI void wkhtmltopdf_begin_convertion(wkhtmltopdf_converter * converter); */
+/* CAPI void wkhtmltopdf_cancel(wkhtmltopdf_converter * converter); */
 CAPI int wkhtmltopdf_convert(wkhtmltopdf_converter * converter);
-CAPI void wkhtmltopdf_cancel(wkhtmltopdf_converter * converter);
 CAPI void wkhtmltopdf_add_resource(
 	wkhtmltopdf_converter * converter, wkhtmltopdf_object_settings * setting, const char * data);
 

src/lib/pdf_c_bindings.cc

@@ -70,6 +70,12 @@ MyPdfConverter::~MyPdfConverter() {
 	objectSettings.clear();
 }
 
+
+/**
+ * \brief Check if the library is build against the wkhtmltopdf version of QT
+ *
+ * \return 1 if the library was build against the wkhtmltopdf version of QT and 0 otherwize
+ */
 CAPI int wkhtmltopdf_extended_qt() {
 #ifdef __EXTENSIVE_WKHTMLTOPDF_QT_HACK__
 	return 1;
@@ -78,32 +84,50 @@ CAPI int wkhtmltopdf_extended_qt() {
 #endif
 }
 
-
-CAPI int wkhtmltopdf_init(int ug) {
+/**
+ * \brief Setup wkhtmltopdf
+ *
+ * Must be called before any other functions.
+ *
+ * \param use_graphics Should we use a grahics system
+ * \returns 1 on success and 0 otherwize
+ *
+ * \sa wkhtmltopdf_deinit
+ */
+CAPI int wkhtmltopdf_init(int use_graphics) {
 	if (qApp == 0) {
 		char * arg[] = {"wkhtmltox", 0};
 		int aa;
 
-		bool use_graphics=true;
+		bool ug = true;
 #if defined(Q_WS_X11) || defined(Q_WS_MACX)
 #ifdef __EXTENSIVE_WKHTMLTOPDF_QT_HACK__
-		use_graphics=ug;
-		if (!use_graphics) QApplication::setGraphicsSystem("raster");
+		ug = use_graphics;
+		if (!ug) QApplication::setGraphicsSystem("raster");
 #endif
 #endif
-		a = new QApplication(aa,arg,use_graphics);
+		a = new QApplication(aa, arg, ug);
 		MyLooksStyle * style = new MyLooksStyle();
 		a->setStyle(style);
 	}
 	return 1;
 }
 
+/**
+ * \brief Deinit wkhtmltopdf
+ *
+ * Free up resources used by wkhtmltopdf, when this has been called no other
+ * wkhtmltopdf function can be called.
+ *
+ * \returns 1 on success and 0 otherwize
+ *
+ * \sa wkhtmltopdf_init
+ */
 CAPI int wkhtmltopdf_deinit() {
 	if (a != 0) delete a;
 	return 1;
 }
 
-
 /**
  * \brief Create a new global settings object for pdf convertion
  *