Doc app / project (#4868)

pkg/application/application.go

@@ -20,14 +20,8 @@ const (
 	appList       = "List"
 )
 
-// List all applications in current project
+// List all applications names in current project by looking at `app` labels in deploymentconfigs, deployments and services instances
 func List(client *occlient.Client) ([]string, error) {
-	return ListInProject(client)
-}
-
-// ListInProject lists all applications in given project by Querying the cluster
-func ListInProject(client *occlient.Client) ([]string, error) {
-
 	var appNames []string
 
 	if client == nil {
@@ -70,7 +64,7 @@ func ListInProject(client *occlient.Client) ([]string, error) {
 	return util.RemoveDuplicates(appNames), nil
 }
 
-// Exists checks whether the given app exist or not
+// Exists checks whether the given app exist or not in the list of applications
 func Exists(app string, client *occlient.Client, kClient *kclient.Client) (bool, error) {
 
 	appList, err := List(client)
@@ -86,7 +80,7 @@ func Exists(app string, client *occlient.Client, kClient *kclient.Client) (bool,
 	return false, nil
 }
 
-// Delete deletes the given application
+// Delete the given application by deleting deploymentconfigs, deployments and services instances belonging to this application
 func Delete(client *occlient.Client, name string) error {
 	klog.V(4).Infof("Deleting application %s", name)
 

pkg/application/doc.go

@@ -0,0 +1,5 @@
+// Package application provides functions to list, check existence of, delete and get machine readable description of applications.
+// An application is a set of components and services.
+// An application is materialized by the `app:` label in `deployments`, `deploymentconfigs`,
+// or service instances (service instances from Service Catalog or from Operator Backed Services).
+package application

pkg/project/doc.go

@@ -0,0 +1,4 @@
+// Package project provides functions to create, delete, list, check existence of and get machine readable description of projects,
+// and to get and set the current project.
+// A project is represented either by a `project.project.openshift.io` resource (in OpenShift) or by a `namespace` in Kubernetes.
+package project

pkg/project/project.go

@@ -10,12 +10,12 @@ import (
 
 const apiVersion = "odo.dev/v1alpha1"
 
-// GetCurrent return current project
+// GetCurrent returns the name of the current project
 func GetCurrent(context *genericclioptions.Context) string {
 	return context.KClient.GetCurrentNamespace()
 }
 
-// SetCurrent sets the projectName as current project
+// SetCurrent sets projectName as the current project
 func SetCurrent(context *genericclioptions.Context, projectName string) error {
 	err := context.KClient.SetCurrentNamespace(projectName)
 	if err != nil {
@@ -24,6 +24,11 @@ func SetCurrent(context *genericclioptions.Context, projectName string) error {
 	return nil
 }
 
+// Create a new project, either by creating a `project.openshift.io` resource if supported by the cluster
+// (which will trigger the creation of a namespace),
+// or by creating directly a `namespace` resource.
+// With the `wait` flag, the function will wait for the `default` service account
+// to be created in the namespace before to return.
 func Create(context *genericclioptions.Context, projectName string, wait bool) error {
 	if projectName == "" {
 		return errors.Errorf("no project name given")
@@ -55,7 +60,8 @@ func Create(context *genericclioptions.Context, projectName string, wait bool) e
 	return nil
 }
 
-// Delete deletes the project with name projectName and returns errors if any
+// Delete deletes the project (the `project` resource if supported, or directly the `namespace`)
+// with the name projectName and returns an error if any
 func Delete(context *genericclioptions.Context, projectName string, wait bool) error {
 	if projectName == "" {
 		return errors.Errorf("no project name given")
@@ -81,8 +87,7 @@ func Delete(context *genericclioptions.Context, projectName string, wait bool) e
 	return nil
 }
 
-// List lists all the projects on the cluster
-// returns a list of the projects or the error if any
+// List all the projects on the cluster on a machine readable format and returns an error if any
 func List(context *genericclioptions.Context) (ProjectList, error) {
 	currentProject := context.KClient.GetCurrentNamespace()
 
@@ -116,10 +121,7 @@ func List(context *genericclioptions.Context) (ProjectList, error) {
 	return getMachineReadableFormatForList(projects), nil
 }
 
-// Exists Checks whether a project with the given name exists or not
-// projectName is the project name to perform check for
-// The first returned parameter is a bool indicating if a project with the given name already exists or not
-// The second returned parameter is the error that might occurs while execution
+// Exists checks whether a project with the name `projectName` exists and returns an error if any
 func Exists(context *genericclioptions.Context, projectName string) (bool, error) {
 	projectSupport, err := context.Client.IsProjectSupported()
 	if err != nil {