[glom] Correct doxygen @param comments.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glom] Correct doxygen @param comments.
- Date: Tue, 9 Feb 2016 20:21:39 +0000 (UTC)
commit 130667758ca3a9d8d9ebb61fdc9cb5f9740bd045
Author: Murray Cumming <murrayc murrayc com>
Date: Tue Feb 9 21:21:23 2016 +0100
Correct doxygen @param comments.
glom/libglom/db_utils.h | 4 ++--
glom/libglom/document/document.h | 8 ++++----
glom/libglom/translations_po.h | 6 +++---
glom/libglom/utils.h | 2 +-
4 files changed, 10 insertions(+), 10 deletions(-)
---
diff --git a/glom/libglom/db_utils.h b/glom/libglom/db_utils.h
index d975cb1..293e657 100644
--- a/glom/libglom/db_utils.h
+++ b/glom/libglom/db_utils.h
@@ -111,7 +111,7 @@ bool insert_example_data(const std::shared_ptr<const Document>& document, const
/** Execute a SQL Select command, returning the result.
* @param builder The finished SqlBuilder object.
- * @use_cursor Whether the data model should be cursor-based (not allowing random access).
+ * @param use_cursor Whether the data model should be cursor-based (not allowing random access).
*/
Glib::RefPtr<Gnome::Gda::DataModel> query_execute_select(
const Glib::RefPtr<const Gnome::Gda::SqlBuilder>& builder,
@@ -171,7 +171,7 @@ Glib::ustring get_unused_database_name(const Glib::ustring& base_name);
* This uses a COUNT * on a the @a sql_query as a sub-statement.
* Be careful not to include ORDER BY clauses in the supplied SQL query, because that would make it
unnecessarily slow.
*
- * @sql_query A SQL query.
+ * @param sql_query A SQL query.
* @result The number of rows. Or -1 if something went wrong.
*/
int count_rows_returned_by(const Glib::RefPtr<const Gnome::Gda::SqlBuilder>& sql_query);
diff --git a/glom/libglom/document/document.h b/glom/libglom/document/document.h
index 3c59837..4f30620 100644
--- a/glom/libglom/document/document.h
+++ b/glom/libglom/document/document.h
@@ -256,7 +256,7 @@ public:
void set_data_layout_groups(const Glib::ustring& layout_name, const Glib::ustring& parent_table_name,
const Glib::ustring& layout_platform, const type_list_layout_groups& groups);
/**
- * @param The layout_name, such as "details", "list".
+ * @param layout_name The layout_name, such as "details", "list".
* @param parent_table_name The name of the table on whose layout the layout appears.
* @param layout_platform The platform for which this layout should be used. Possible values are an empty
string (meaning normal platforms) or "maemo" meaning "normal".
*/
@@ -413,7 +413,7 @@ public:
* @param x The x coordinate of the table position.
* @param y The y coordinate of the table position.
*/
- void set_table_overview_position( const Glib::ustring& utable_name, float x, float y );
+ void set_table_overview_position( const Glib::ustring& table_name, float x, float y );
enum class userLevelReason
{
@@ -448,7 +448,7 @@ public:
Glib::ustring get_active_layout_platform() const;
/** This is transitory information, not saved to disk.
- * @layout_platform the active platform name - see get_data_layout_groups().
+ * @param layout_platform the active platform name - see get_data_layout_groups().
*/
void set_active_layout_platform(const Glib::ustring& layout_platform = Glib::ustring());
@@ -463,7 +463,7 @@ public:
/** Save a copy of the document as a backup.
* This document (and its URI) will not be changed.
- * @param The location at which to save the backup Glom file.
+ * @param uri The location at which to save the backup Glom file.
* @result The URI of the .tar.gz tarball.
*/
Glib::ustring save_backup_file(const Glib::ustring& uri, const SlotProgress& slot_progress);
diff --git a/glom/libglom/translations_po.h b/glom/libglom/translations_po.h
index 09e9c81..d5ad2bf 100644
--- a/glom/libglom/translations_po.h
+++ b/glom/libglom/translations_po.h
@@ -28,13 +28,13 @@ namespace Glom
/** Create a pot template file that can be used by translators to create a new .po file.
* @param document The document whose translations should be written to a .po file.
- * @param pot_file The filepath at which to create a .po file.
+ * @param pot_file_uri The filepath at which to create a .po file.
*/
bool write_pot_file(const std::shared_ptr<Document>& document, const Glib::ustring& pot_file_uri);
/** Create a po file containing the translations from the Glom document.
* @param document The document whose translations should be written to a .po file.
- * @param po_file The filepath at which to create a .po file.
+ * @param po_file_uri The filepath at which to create a .po file.
* @param translation_locale For instance, de_DE.
* @param locale_name For instance, Deutsch, to identify the translation team.
*/
@@ -42,7 +42,7 @@ bool write_translations_to_po_file(const std::shared_ptr<Document>& document, co
/** Parse a po file, storing its translations in the Glom document.
* @param document The document into which the translations should be stored.
- * @param po_file The filepath at which to find a .po file.
+ * @param po_file_uri The filepath at which to find a .po file.
* @param translation_locale For instance, de_DE.
*/
bool import_translations_from_po_file(const std::shared_ptr<Document>& document, const Glib::ustring&
po_file_uri, const Glib::ustring& translation_locale);
diff --git a/glom/libglom/utils.h b/glom/libglom/utils.h
index 501e8ed..f4420c3 100644
--- a/glom/libglom/utils.h
+++ b/glom/libglom/utils.h
@@ -119,7 +119,7 @@ Glib::RefPtr<Gnome::Gda::SqlBuilder> build_sql_select_with_key(
* This uses a COUNT * on a the @a sql_query as a sub-statement.
* Be careful not to include ORDER BY clauses in the supplied SQL query, because that would make it
unnecessarily slow.
*
- * @sql_query A SQL query.
+ * @param sql_query A SQL query.
* @result The number of rows.
*/
Glib::RefPtr<Gnome::Gda::SqlBuilder> build_sql_select_count_rows(const Glib::RefPtr<const
Gnome::Gda::SqlBuilder>& sql_query);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]