doc: Added godoc style comments for APIs and structs

Author: RawanMostafa08

pkg/httpUtil.go

@@ -1,4 +1,4 @@
-// This package implements an http client
+// This package implements an http client for resource and pokemon APIs from pokeAPI
 package pokemon
 
 import (

pkg/pokemon.go

@@ -1,3 +1,4 @@
+// This package implements an http client for resource and pokemon APIs from pokeAPI
 package pokemon
 
 import (
@@ -6,7 +7,8 @@ import (
 
 	"golang.org/x/exp/slog"
 )
-
+// Pokemon takes the pokemon id as an integer, send the request with the /pokemon endpoint 
+// parses the response and returns the Pokemon object and an error if exists
 func (c Client) Pokemon(id int) (pokemon Pokemon, err error) {
 	c.Endpoint = fmt.Sprintf("/pokemon/%d", id)
 	resp, err := c.sendRequest()

pkg/resource.go

@@ -1,3 +1,4 @@
+// This package implements an http client for resource and pokemon APIs from pokeAPI
 package pokemon
 
 import (
@@ -6,6 +7,9 @@ import (
 	"golang.org/x/exp/slog"
 )
 
+// Resource takes optional options, send the request
+// with the specified endpoint in the caller client object endpoint
+// parses the response and returns the Resource object and an error if exists
 func (c Client) Resource(options ...int) (resource Resource, err error) {
 
 	resp, err := c.sendRequest(options...)

pkg/types.go

@@ -1,16 +1,21 @@
+// This package implements an http client for resource and pokemon APIs from pokeAPI
 package pokemon
 
+// Resource is the resources available for an endpoint
 type Resource struct {
 	Count    int      `json:"count"`
 	Next     string   `json:"next"`
 	Previous string   `json:"previous"`
 	Results  []Result `json:"results"`
 }
+
+// Result is a single API resource
 type Result struct {
 	Url  string `json:"url"`
 	Name string `json:"name"`
 }
 
+// Pokemon holds a single pokemon data
 type Pokemon struct {
 	ID                     int               `json:"id"`
 	Name                   string            `json:"name"`
@@ -32,72 +37,112 @@ type Pokemon struct {
 	Stats                  []PokemonStat     `json:"stats"`
 	Types                  []PokemonType     `json:"types"`
 }
-type Ability struct {
-	Name string `json:"name"`
-	URL  string `json:"url"`
-}
+
+// PokemonAbility is a single pokemon ability
 type PokemonAbility struct {
 	IsHidden bool    `json:"is_hidden"`
 	Slot     int     `json:"slot"`
 	Ability  Ability `json:"ability"`
 }
-type Form struct {
+
+// Ability is an API resource
+type Ability struct {
 	Name string `json:"name"`
 	URL  string `json:"url"`
 }
-type Version struct {
+
+// Form is a named API resource
+type Form struct {
 	Name string `json:"name"`
 	URL  string `json:"url"`
 }
+
+// GameIndex is a single game index
 type GameIndex struct {
 	GameIndex int     `json:"game_index"`
 	Version   Version `json:"version"`
 }
+
+// Version is a named API resource
+type Version struct {
+	Name string `json:"name"`
+	URL  string `json:"url"`
+}
+
+// Item is a named API resource
+type Item struct {
+	Name string `json:"name"`
+	URL  string `json:"url"`
+}
+
+// PokemonHeldItem is a single Pokemon item
 type PokemonHeldItem struct {
 	Item           Item                   `json:"item"`
 	VersionDetails PokemonHeldItemVersion `json:"version_details"`
 }
+
+// PokemonHeldItemVersion hold the information about the held item version
 type PokemonHeldItemVersion struct {
 	Version Version `json:"version"`
 	Rarity  int     `json:"rarity"`
 }
-type Move struct {
-	Name string `json:"name"`
-	URL  string `json:"url"`
-}
-type Item struct {
-	Name string `json:"name"`
-	URL  string `json:"url"`
-}
+
+// MoveLearnMethod is a named API resource
 type MoveLearnMethod struct {
 	Name string `json:"name"`
 	URL  string `json:"url"`
 }
+
+// VersionGroup is a named API resource
 type VersionGroup struct {
 	Name string `json:"name"`
 	URL  string `json:"url"`
 }
+
+// PokemonMoveVersion holds the details about the pokemon move versions
 type PokemonMoveVersion struct {
 	MoveLearnMethod MoveLearnMethod `json:"move_learn_method"`
 	VersionGroup    VersionGroup    `json:"version_group"`
 	LevelLearnedAt  int             `json:"level_learned_at"`
 }
+
+// Move is a named API resource
+type Move struct {
+	Name string `json:"name"`
+	URL  string `json:"url"`
+}
+
+// PokemonMove is a single pokemon move
 type PokemonMove struct {
 	Move                Move                 `json:"move"`
 	VersionGroupDetails []PokemonMoveVersion `json:"version_group_details"`
 }
+
+// Type is a named API resource
+type Type struct {
+	Name string `json:"name"`
+	URL  string `json:"url"`
+}
+
+// PokemonType is a single pokemon type
+type PokemonType struct {
+	Slot int  `json:"slot"`
+	Type Type `json:"type"`
+}
+
+// Generation is a named API resource
 type Generation struct {
 	Name string `json:"name"`
 	URL  string `json:"url"`
 }
+
+// PokemonTypePast is a single pokemon past type
 type PokemonTypePast struct {
 	Generation Generation    `json:"generation"`
 	Types      []PokemonType `json:"types"`
 }
-type Species struct {
-	Name string `json:"name"`
-	URL  string `json:"url"`
-}
+
+// PokemonSprites holds the details about single pokemon sprites
 type PokemonSprites struct {
 	FrontDefault     string `json:"front_default"`
 	FrontShiny       string `json:"front_shiny"`
@@ -108,24 +153,28 @@ type PokemonSprites struct {
 	BackFemale       string `json:"back_female"`
 	BackShinyFemale  string `json:"back_shiny_female"`
 }
+
+// PokemonCries holds the details about single pokemon cries
+type PokemonCries struct {
+	Latest string `json:"latest"`
+	Legacy string `json:"legacy"`
+}
+
+// Species is a named API resource
+type Species struct {
+	Name string `json:"name"`
+	URL  string `json:"url"`
+}
+
+// Stat is a named API resource
 type Stat struct {
 	Name string `json:"name"`
 	URL  string `json:"url"`
 }
+
+// PokemonStat holds the details about single pokemon stats
 type PokemonStat struct {
 	Stat     Stat `json:"stat"`
 	BaseStat int  `json:"base_stat"`
 	Effort   int  `json:"effort"`
 }
-type Type struct {
-	Name string `json:"name"`
-	URL  string `json:"url"`
-}
-type PokemonType struct {
-	Slot int  `json:"slot"`
-	Type Type `json:"type"`
-}
-type PokemonCries struct {
-	Latest string `json:"latest"`
-	Legacy string `json:"legacy"`
-}