[easytag/wip/musicbrainz-support] Added Comments for Structs and Enums in header files
- From: Abhinav Jangda <abhijangda src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [easytag/wip/musicbrainz-support] Added Comments for Structs and Enums in header files
- Date: Wed, 23 Jul 2014 12:06:28 +0000 (UTC)
commit 15351ac5491533fdf7f10d7c46c515e68b220ae7
Author: Abhinav <abhijangda hotmail com>
Date: Wed Jul 23 17:35:47 2014 +0530
Added Comments for Structs and Enums in header files
src/mb_search.h | 13 ++++++++-
src/mbentityview.c | 11 +++----
src/mbentityview.h | 37 +++++++++++++++++++++++++
src/musicbrainz_dialog.c | 67 +++++++++++++++++++++++++++++++++++++++++++++-
4 files changed, 120 insertions(+), 8 deletions(-)
---
diff --git a/src/mb_search.h b/src/mb_search.h
index 181fa68..a6929c8 100755
--- a/src/mb_search.h
+++ b/src/mb_search.h
@@ -71,9 +71,20 @@ typedef enum
ET_MB5_SEARCH_ERROR_DISCID,
} EtMB5SearchError;
+/*
+ * MbEntityKind:
+ * @MB_ENTITY_KIND_ARTIST: Entity is of Artist Type
+ * @MB_ENTITY_KIND_ALBUM: Entity is of Abum Type
+ * @MB_ENTITY_KIND_TRACK: Entity is of Track Type
+ * @MB_ENTITY_KIND_FREEDBID: Entity is of FreeDBID Type
+ * @MB_ENTITY_KIND_COUNT: Total Entities
+ * @MB_ENTITY_KIND_DISCID: Entity is of DiscID Type
+ *
+ * Type of MusicBrainz Entity.
+ */
typedef enum _MbEntityKind
{
- MB_ENTITY_KIND_ARTIST = 0,
+ MB_ENTITY_KIND_ARTIST,
MB_ENTITY_KIND_ALBUM,
MB_ENTITY_KIND_TRACK,
MB_ENTITY_KIND_FREEDBID,
diff --git a/src/mbentityview.c b/src/mbentityview.c
index f4c7a62..18399a6 100755
--- a/src/mbentityview.c
+++ b/src/mbentityview.c
@@ -771,12 +771,7 @@ search_in_levels_thread_func (GSimpleAsyncResult *res, GObject *obj,
}
if (((EtMbEntity *)thread_data->child->data)->type ==
- MB_ENTITY_KIND_TRACK)
- {
- return;
- }
- else if (((EtMbEntity *)thread_data->child->data)->type ==
- MB_ENTITY_KIND_ARTIST)
+ MB_ENTITY_KIND_ARTIST)
{
child_entity_type_str = g_strdup ("Albums ");
mb5_artist_get_id (((EtMbEntity *)thread_data->child->data)->entity,
@@ -804,6 +799,10 @@ search_in_levels_thread_func (GSimpleAsyncResult *res, GObject *obj,
g_stpcpy (parent_entity_str, mbid);
to_search = MB_ENTITY_KIND_ALBUM;
}
+ else
+ {
+ return;
+ }
error = NULL;
status_msg = g_strconcat (_("Retrieving "), child_entity_type_str, "for ",
diff --git a/src/mbentityview.h b/src/mbentityview.h
index 0e72b54..8a0d2a5 100755
--- a/src/mbentityview.h
+++ b/src/mbentityview.h
@@ -73,6 +73,15 @@ typedef struct
GtkBoxClass parent;
} EtMbEntityViewClass;
+/*
+ * MB_ARTIST_COLUMNS:
+ * @MB_ARTIST_COLUMNS_NAME
+ * @MB_ARTIST_COLUMNS_GENDER
+ * @MB_ARTIST_COLUMNS_TYPE
+ * @MB_ARTIST_COLUMNS_N
+ *
+ * Columns for Artist
+ */
enum MB_ARTIST_COLUMNS
{
MB_ARTIST_COLUMNS_NAME,
@@ -81,6 +90,15 @@ enum MB_ARTIST_COLUMNS
MB_ARTIST_COLUMNS_N
};
+/*
+ * MB_ALBUM_COLUMNS:
+ * @MB_ALBUM_COLUMNS_NAME
+ * @MB_ALBUM_COLUMNS_ARTIST
+ * @MB_ALBUM_COLUMNS_TYPE
+ * @MB_ALBUM_COLUMNS_N
+ *
+ * Columns for Albums
+ */
enum MB_ALBUM_COLUMNS
{
MB_ALBUM_COLUMNS_NAME,
@@ -89,6 +107,16 @@ enum MB_ALBUM_COLUMNS
MB_ALBUM_COLUMNS_N
};
+/*
+ * MB_TRACK_COLUMNS:
+ * @MB_TRACK_COLUMNS_NAME
+ * @MB_TRACK_COLUMNS_ALBUM
+ * @MB_TRACK_COLUMNS_ARTIST
+ * @MB_TRACK_COLUMNS_TIME
+ * @MB_TRACK_COLUMNS_N
+ *
+ * Columns for Track
+ */
enum MB_TRACK_COLUMNS
{
MB_TRACK_COLUMNS_NAME,
@@ -98,6 +126,15 @@ enum MB_TRACK_COLUMNS
MB_TRACK_COLUMNS_N
};
+/*
+ * MB_FREEDBID_COLUMNS:
+ * @MB_FREEDBID_COLUMNS_ID
+ * @MB_FREEDBID_COLUMNS_NAME
+ * @MB_FREEDBID_COLUMNS_ARTIST
+ * @MB_FREEDBID_COLUMNS_N
+ *
+ * Columns for FreeDBID
+ */
enum MB_FREEDBID_COLUMNS
{
MB_FREEDBID_COLUMNS_ID,
diff --git a/src/musicbrainz_dialog.c b/src/musicbrainz_dialog.c
index 1d1e6b0..1c7e5d4 100755
--- a/src/musicbrainz_dialog.c
+++ b/src/musicbrainz_dialog.c
@@ -41,6 +41,18 @@
* Declaration *
***************/
+/*
+ * TagChoiceColumns:
+ * @TAG_CHOICE_TITLE:
+ * @TAG_CHOICE_ALBUM:
+ * @TAG_CHOICE_ARTIST:
+ * @TAG_CHOICE_ALBUM_ARTIST:
+ * @TAG_CHOICE_DATE:
+ * @TAG_CHOICE_COUNTRY:
+ * @TAG_CHOICE_COLS_N:
+ *
+ * Tag Choice Columns
+ */
enum TagChoiceColumns
{
TAG_CHOICE_TITLE,
@@ -51,7 +63,15 @@ enum TagChoiceColumns
TAG_CHOICE_COUNTRY,
TAG_CHOICE_COLS_N
};
-
+
+/*
+ * EtMbSearchType:
+ * @ET_MB_SEARCH_TYPE_MANUAL: Manual Search Type
+ * @ET_MB_SEARCH_TYPE_SELECTED: Selected Search Type
+ * @ET_MB_SEARCH_TYPE_AUTOMATIC: Automatic Search Type
+ *
+ * Represents type of Search.
+ */
typedef enum
{
ET_MB_SEARCH_TYPE_MANUAL,
@@ -59,17 +79,39 @@ typedef enum
ET_MB_SEARCH_TYPE_AUTOMATIC,
} EtMbSearchType;
+/*
+ * SelectedFindThreadData:
+ * @text_to_search: Manual Search Text
+ * @type: Type of Entity
+ *
+ * Thread Data for storing Manual Search's data.
+ */
typedef struct
{
GHashTable *hash_table;
GList *list_iter;
} SelectedFindThreadData;
+/*
+ * EtMbSearch:
+ * @type: Type of Search
+ *
+ * Thread Data for storing EtMbSearch's data.
+ */
typedef struct
{
EtMbSearchType type;
} EtMbSearch;
+/*
+ * EtMbManualSearch:
+ * @parent: Parent Struct
+ * @to_search: String to search
+ * @to_search_type: EtMbEntityType to search
+ * @parent_node: Parent Node
+ *
+ * Stores information about Manual Search.
+ */
typedef struct
{
EtMbSearch parent;
@@ -78,17 +120,40 @@ typedef struct
GNode *parent_node;
} EtMbManualSearch;
+/*
+ * EtMbSelectedSearch:
+ * @parent: Parent Struct
+ * @list_iter: List of Files.
+ *
+ * Stores information about Selected Files Search.
+ */
typedef struct
{
EtMbSearch parent;
GList *list_iter;
} EtMbSelectedSearch;
+/*
+ * EtMbAutomaticSearch:
+ * @parent: Parent Struct
+ *
+ * Stores information about Automatic Search.
+ */
typedef struct
{
EtMbSearch parent;
} EtMbAutomaticSearch;
+/*
+ * MusicBrainzDialogPrivate:
+ * @mb_tree_root: Root of Node Tree
+ * @async_result: GSimpleAsyncResult
+ * @search: EtMbSearch storing information about previous search
+ * @tag_choice_store: GtkTreeModel for Tag Choice Dialog
+ * @tag_choice_dialog: Tag Choice Dialog
+ *
+ * Private data for MusicBrainzDialog.
+ */
typedef struct
{
GNode *mb_tree_root;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]