style(docs): update entities doc comments

Author: ryanaidilp

packages/stadata_flutter_sdk/lib/src/features/census/domain/entities/census_area.dart

@@ -1,30 +1,33 @@
 import 'package:stadata_flutter_sdk/src/core/base/base.dart';
 
-/// Represents a geographical area covered by a census event
+/// Entity class representing geographical areas covered by census events from BPS Web API.
 ///
-/// This entity contains information about geographical areas where census
-/// data collection takes place, including provinces, regencies, and cities.
+/// This class maps to the census areas endpoint:
+/// `https://webapi.bps.go.id/v1/api/interoperabilitas/datasource/sensus/id/39/`
 ///
-/// Reference: https://webapi.bps.go.id/documentation/#census
+/// Contains information about geographical areas where census data collection
+/// takes place, including provinces (provinsi), regencies (kabupaten), and
+/// cities (kota) across Indonesia.
 class CensusArea extends BaseEntity {
-  /// Creates a [CensusArea] with the specified properties
+  /// Creates a new [CensusArea] instance.
   const CensusArea({
     required this.id,
     required this.name,
     required this.slug,
     required this.mfdCode,
   });
 
-  /// Unique identifier for the census area
+  /// Unique identifier for the geographical area
   final int id;
 
-  /// Name of the geographical area
+  /// Official name of the geographical area (e.g., "DKI Jakarta", "Kabupaten Bogor")
   final String name;
 
-  /// URL-friendly slug representation of the area name
+  /// URL-friendly slug representation of the area name for web usage
   final String slug;
 
-  /// MFD (Master File Data) code for the area
+  /// MFD (Master File Data) code for administrative identification
+  /// Used for linking with other BPS administrative data systems
   final String mfdCode;
 
   @override

packages/stadata_flutter_sdk/lib/src/features/census/domain/entities/census_category.dart

@@ -1,9 +1,15 @@
 import 'package:stadata_flutter_sdk/src/core/core.dart';
 
-/// Entity class representing a census data category.
+/// Entity class representing census data categories from BPS Web API.
 ///
-/// Each category contains classification information with items
-/// that help categorize the census data (e.g., age groups, gender, etc.).
+/// This class maps to the census categories endpoint and contains
+/// classification information with items that help categorize census data
+/// such as age groups (kelompok umur), gender (jenis kelamin),
+/// education levels (tingkat pendidikan), or economic sectors (sektor ekonomi).
+///
+/// Categories provide hierarchical organization of census data to enable
+/// detailed statistical analysis and cross-tabulation of demographic
+/// and socioeconomic indicators.
 class CensusCategory extends BaseEntity {
   /// Creates a new [CensusCategory] instance.
   const CensusCategory({
@@ -14,19 +20,21 @@ class CensusCategory extends BaseEntity {
     required this.itemName,
   });
 
-  /// Category identifier
+  /// Unique identifier for the census category
   final String id;
 
-  /// Category name/description
+  /// Descriptive name of the category (e.g., "Age Group", "Gender", "Education Level")
   final String name;
 
-  /// Category item identifier
+  /// Identifier for the specific item within this category
   final String itemID;
 
-  /// Category item code
+  /// Standardized code for the category item used in data classification
+  /// Follows BPS coding standards for statistical categorization
   final String itemCode;
 
-  /// Category item name/description
+  /// Human-readable name/description of the category item
+  /// (e.g., "15-19 years", "Male", "High School")
   final String itemName;
 
   @override

packages/stadata_flutter_sdk/lib/src/features/census/domain/entities/census_dataset.dart

@@ -1,14 +1,15 @@
 import 'package:stadata_flutter_sdk/src/core/core.dart';
 
-/// Represents a dataset within a census event topic
+/// Entity class representing datasets within census event topics from BPS Web API.
 ///
-/// This entity contains information about specific datasets available
-/// for a census event, organized by topics such as population,
-/// housing, agriculture, or economic activities.
+/// This class maps to the census datasets endpoint:
+/// `https://webapi.bps.go.id/v1/api/interoperabilitas/datasource/sensus/id/40/`
 ///
-/// Reference: https://webapi.bps.go.id/documentation/#census
+/// Contains information about specific datasets available for census events,
+/// organized by topics such as population (penduduk), housing (perumahan),
+/// agriculture (pertanian), or economic activities (kegiatan ekonomi).
 class CensusDataset extends BaseEntity {
-  /// Creates a [CensusDataset] with the specified properties
+  /// Creates a new [CensusDataset] instance.
   const CensusDataset({
     required this.id,
     required this.topicID,
@@ -18,22 +19,25 @@ class CensusDataset extends BaseEntity {
     this.description,
   });
 
-  /// Unique identifier for the dataset
+  /// Unique identifier for the census dataset
   final int id;
 
   /// Identifier of the topic this dataset belongs to
+  /// Links to the corresponding census topic
   final int topicID;
 
-  /// Name of the topic category (e.g., "Population", "Housing")
+  /// Name of the topic category (e.g., "Population", "Housing", "Agriculture")
   final String topic;
 
   /// Identifier of the census event this dataset is part of
+  /// Links to the corresponding census event
   final int eventID;
 
-  /// Name of the dataset
+  /// Descriptive name of the dataset indicating what data it contains
   final String name;
 
-  /// Optional description providing more details about the dataset
+  /// Optional detailed description providing more context about the dataset
+  /// May include methodology, scope, or data collection notes
   final String? description;
 
   @override

packages/stadata_flutter_sdk/lib/src/features/census/domain/entities/census_event.dart

@@ -1,10 +1,25 @@
 import 'package:stadata_flutter_sdk/src/core/core.dart';
 
-/// Entity class representing a census activity/event from BPS Web API.
+/// Entity class representing major census activities and events from BPS Web API.
 ///
 /// This class maps to the census events endpoint:
 /// `https://webapi.bps.go.id/v1/api/interoperabilitas/datasource/sensus/id/37/`
 ///
+/// Census events represent major data collection activities conducted by BPS
+/// on a periodic basis to gather comprehensive demographic, housing, economic,
+/// and agricultural statistics across Indonesia. These large-scale surveys
+/// provide foundational data for national planning and policy development.
+///
+/// Major census types include:
+/// - Population Census (Sensus Penduduk) - conducted every 10 years
+/// - Economic Census (Sensus Ekonomi) - business and economic activity data
+/// - Agricultural Census (Sensus Pertanian) - farming and agricultural statistics
+/// - Inter-census Population Survey (SUPAS) - mid-decade population updates
+///
+/// Each census event spans multiple years from planning through data collection
+/// to final publication, with standardized methodologies ensuring data quality
+/// and comparability across time periods.
+///
 /// Example response from API:
 /// ```json
 /// {
@@ -15,19 +30,27 @@ import 'package:stadata_flutter_sdk/src/core/core.dart';
 /// ```
 class CensusEvent extends BaseEntity {
   /// Creates a new [CensusEvent] instance.
-  ///
-  /// [id] is the unique identifier for the census activity (e.g. "sp2020")
-  /// [name] is the name/description of the census activity
-  /// [year] is the year when the census was conducted
   const CensusEvent({required this.id, required this.name, required this.year});
 
-  /// Unique identifier for the census activity
+  /// Unique standardized identifier for the census activity
+  ///
+  /// Uses BPS coding conventions combining census type and year.
+  /// Examples: "sp2020" (Sensus Penduduk 2020), "se2016" (Sensus Ekonomi 2016),
+  /// "st2013" (Sensus Pertanian 2013), "supas2015" (Survei Penduduk Antar Sensus)
   final String id;
 
-  /// Name/description of the census activity
+  /// Official name and description of the census activity
+  ///
+  /// Full Indonesian title of the census as published by BPS.
+  /// Examples: "Sensus Penduduk 2020", "Sensus Ekonomi 2016",
+  /// "Sensus Pertanian 2013", "Survei Penduduk Antar Sensus 2015"
   final String name;
 
-  /// Year when the census was conducted
+  /// Reference year when the main data collection period occurred
+  ///
+  /// Represents the primary year of fieldwork and data gathering,
+  /// though planning and analysis may span multiple years.
+  /// Used for temporal organization and data series identification.
   final int year;
 
   @override

packages/stadata_flutter_sdk/lib/src/features/census/domain/entities/census_topic.dart

@@ -1,10 +1,29 @@
 import 'package:stadata_flutter_sdk/src/core/core.dart';
 
-/// Represents a census topic/subject from BPS Web API.
+/// Entity class representing thematic topics within census events from BPS Web API.
 ///
 /// This class maps to the census topics endpoint:
 /// `https://webapi.bps.go.id/v1/api/interoperabilitas/datasource/sensus/id/38`
 ///
+/// Census topics represent specific subject areas or themes covered within
+/// a larger census event. They organize census data into logical categories
+/// that correspond to different aspects of demographic, social, and economic
+/// characteristics collected during the census.
+///
+/// Common census topics include:
+/// - Population characteristics (jumlah dan distribusi penduduk)
+/// - Housing conditions (kondisi perumahan)
+/// - Educational attainment (tingkat pendidikan)
+/// - Employment and labor force (ketenagakerjaan)
+/// - Migration patterns (migrasi)
+/// - Fertility and mortality (fertilitas dan mortalitas)
+/// - Disability status (penyandang disabilitas)
+/// - Economic activities (kegiatan ekonomi)
+///
+/// Each topic provides a structured way to access related datasets and
+/// enables researchers to focus on specific demographic or socioeconomic
+/// dimensions of the census data.
+///
 /// Example response from API:
 /// ```json
 /// {
@@ -18,37 +37,36 @@ import 'package:stadata_flutter_sdk/src/core/core.dart';
 ///   "alias_event": "sp2022"
 /// }
 /// ```
-///
-/// This endpoint is part of the BPS Web API Census Data service that provides
-/// information about specific topics or subjects covered in a census event.
-/// The response includes both Indonesian (topik) and English (topic) versions
-/// of the topic name.
 class CensusTopic extends BaseEntity {
   /// Creates a new [CensusTopic] instance.
-  ///
-  /// Parameters:
-  /// - [id]: Unique identifier for the census topic
-  /// - [topic]: Name/description of the census topic
-  ///   (e.g. "Number and Distribution of Population")
-  /// - [eventID]: ID of the census event this topic belongs to (e.g. "sp2022")
-  /// - [eventName]: Name of the census event (e.g. "Long Form Sensus Penduduk 2020")
   const CensusTopic({
     required this.id,
     required this.topic,
     required this.eventID,
     required this.eventName,
   });
 
-  /// Unique identifier for the census topic
+  /// Unique numerical identifier for the census topic within BPS system
   final int id;
 
-  /// Name/description of the census topic in English
+  /// Descriptive name of the census topic in English
+  ///
+  /// Standardized English terminology for the thematic area covered by this topic.
+  /// Examples: "Number and Distribution of Population", "Housing Characteristics",
+  /// "Educational Attainment", "Labor Force Participation", "Migration Status"
   final String topic;
 
-  /// ID of the census event this topic belongs to (e.g. "sp2022")
+  /// Identifier of the parent census event that contains this topic
+  ///
+  /// Links this topic to its corresponding census event using standardized
+  /// BPS event codes. Examples: "sp2020", "se2016", "st2013"
   final String eventID;
 
-  /// Full name of the census event
+  /// Full official name of the census event in Indonesian
+  ///
+  /// Complete title of the census activity as published by BPS.
+  /// Examples: "Sensus Penduduk 2020", "Long Form Sensus Penduduk 2020",
+  /// "Sensus Ekonomi 2016"
   final String eventName;
 
   @override

packages/stadata_flutter_sdk/lib/src/features/domains/domain/entities/domain_entity.dart

@@ -1,26 +1,45 @@
 import 'package:stadata_flutter_sdk/src/core/core.dart';
 
-/// Dart class representation of BPS Statistics Domain
+/// Entity class representing statistical domains from BPS Web API.
 ///
-/// docs: https://webapi.bps.go.id/documentation/#domain
+/// This class maps to the domains endpoint:
+/// `https://webapi.bps.go.id/v1/api/list/domain/{domain_id}`
+///
+/// Domains represent different geographical or administrative levels where
+/// statistical data is collected and organized, including:
+/// - National level (nasional)
+/// - Provincial level (provinsi)
+/// - Regency/City level (kabupaten/kota)
+/// - Sub-district level (kecamatan)
+///
+/// Each domain provides access to statistical datasets specific to that
+/// administrative boundary, enabling users to retrieve data at the appropriate
+/// geographical scope for their analysis needs.
+///
+/// Documentation: https://webapi.bps.go.id/documentation/#domain
 
 class DomainEntity extends BaseEntity {
-  /// Constructor of DomainEntity
+  /// Creates a new [DomainEntity] instance.
   const DomainEntity({required this.id, required this.name, required this.url});
 
-  /// id of the domain
+  /// Unique identifier for the statistical domain
   ///
-  /// represent 'domain_id' from api response
+  /// Represents 'domain_id' from the API response.
+  /// Common values include province codes (e.g., "3200" for West Java),
+  /// regency codes, or special identifiers like "0000" for national level.
   final String id;
 
-  /// name of the domain
+  /// Descriptive name of the statistical domain
   ///
-  /// represent 'domain_name' from api response
+  /// Represents 'domain_name' from the API response.
+  /// Examples: "DKI Jakarta", "Kabupaten Bogor", "Indonesia"
   final String name;
 
-  /// url of the domain
+  /// Official URL endpoint for accessing this domain's statistical data
   ///
-  /// represent 'domain_url' from api response
+  /// Represents 'domain_url' from the API response.
+  /// Points to the specific BPS regional office or data portal
+  /// responsible for this geographical area.
   final String url;
 
   @override