fix(profile-page): add documentation

ProximaEPFL · Mar 30, 2024 · eb0c1aa · eb0c1aa
1 parent e1e70cb
commit eb0c1aa
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 0 deletions.
diff --git a/lib/views/pages/profile/posts_info/info_card.dart b/lib/views/pages/profile/posts_info/info_card.dart
@@ -1,5 +1,7 @@
 import "package:flutter/material.dart";
 
+/// This widget defines the style of the cards in the profile page,
+/// such as badges, posts and comments
 class InfoCard extends StatelessWidget {
   const InfoCard({
     super.key,

diff --git a/lib/views/pages/profile/posts_info/info_column.dart b/lib/views/pages/profile/posts_info/info_column.dart
@@ -1,5 +1,7 @@
 import "package:flutter/material.dart";
 
+/// This widget defines the style of the columns in the profile page,
+/// such as the posts and comments columns
 class InfoColumn extends StatelessWidget {
   const InfoColumn({
     super.key,

diff --git a/lib/views/pages/profile/posts_info/info_row.dart b/lib/views/pages/profile/posts_info/info_row.dart
@@ -1,5 +1,7 @@
 import "package:flutter/material.dart";
 
+/// This widget defines the style of the rows in the profile page,
+/// such as the badges row
 class InfoRow extends StatelessWidget {
   const InfoRow({
     super.key,

diff --git a/lib/views/pages/profile/profile_page.dart b/lib/views/pages/profile/profile_page.dart
@@ -7,6 +7,8 @@ import "package:proxima/views/pages/profile/posts_info/info_row.dart";
 import "package:proxima/views/pages/profile/user_info/centauri_points.dart";
 import "package:proxima/views/pages/profile/user_info/user_account.dart";
 
+/// This widget is used to display the profile page
+/// It contains the user info, centauri points, badges, posts and comments
 class ProfilePage extends HookConsumerWidget {
   const ProfilePage({super.key});
 

diff --git a/lib/views/pages/profile/user_info/centauri_points.dart b/lib/views/pages/profile/user_info/centauri_points.dart
@@ -1,5 +1,6 @@
 import "package:flutter/material.dart";
 
+/// This widget is used to display the centauri points in the profile page
 class CentauriPoints extends StatelessWidget {
   const CentauriPoints({
     super.key,

diff --git a/lib/views/pages/profile/user_info/user_account.dart b/lib/views/pages/profile/user_info/user_account.dart
@@ -1,5 +1,6 @@
 import "package:flutter/material.dart";
 
+/// This widget display the user info in the profile page
 class UserAccount extends StatelessWidget {
   const UserAccount({
     super.key,