Add org routes documentation

routes/org/members.go

@@ -11,10 +11,14 @@ import (
 )
 
 const (
-	MEMBERS       = "org/member/members"
+	// MEMBERS url
+	MEMBERS = "org/member/members"
+
+	//MEMBER_INVITE url
 	MEMBER_INVITE = "org/member/invite"
 )
 
+//Members shows organization members
 func Members(c *context.Context) {
 	org := c.Org.Organization
 	c.Data["Title"] = org.FullName
@@ -29,6 +33,8 @@ func Members(c *context.Context) {
 	c.HTML(200, MEMBERS)
 }
 
+// MembersAction handle the user actions
+// Like : make organization public/private, delete or leave it
 func MembersAction(c *context.Context) {
 	uid := com.StrTo(c.Query("uid")).MustInt64()
 	if uid == 0 {
@@ -39,18 +45,21 @@ func MembersAction(c *context.Context) {
 	org := c.Org.Organization
 	var err error
 	switch c.Params(":action") {
+	// Make organization private
 	case "private":
 		if c.User.ID != uid && !c.Org.IsOwner {
 			c.Error(404)
 			return
 		}
 		err = models.ChangeOrgUserStatus(org.ID, uid, false)
+	// Make organization public
 	case "public":
 		if c.User.ID != uid && !c.Org.IsOwner {
 			c.Error(404)
 			return
 		}
 		err = models.ChangeOrgUserStatus(org.ID, uid, true)
+	// Remove the organization
 	case "remove":
 		if !c.Org.IsOwner {
 			c.Error(404)
@@ -62,6 +71,7 @@ func MembersAction(c *context.Context) {
 			c.Redirect(c.Org.OrgLink + "/members")
 			return
 		}
+	// Leave the organization
 	case "leave":
 		err = org.RemoveMember(c.User.ID)
 		if models.IsErrLastOrgOwner(err) {
@@ -87,6 +97,7 @@ func MembersAction(c *context.Context) {
 	}
 }
 
+// Invitation validate user invitation to an organization
 func Invitation(c *context.Context) {
 	org := c.Org.Organization
 	c.Data["Title"] = org.FullName
@@ -96,6 +107,7 @@ func Invitation(c *context.Context) {
 		uname := c.Query("uname")
 		u, err := models.GetUserByName(uname)
 		if err != nil {
+			// Check if user exists
 			if errors.IsUserNotExist(err) {
 				c.Flash.Error(c.Tr("form.user_not_exist"))
 				c.Redirect(c.Org.OrgLink + "/invitations/new")
@@ -105,6 +117,7 @@ func Invitation(c *context.Context) {
 			return
 		}
 
+		// Add user to the organization
 		if err = org.AddMember(u.ID); err != nil {
 			c.Handle(500, " AddMember", err)
 			return

routes/org/org.go

@@ -10,14 +10,17 @@ import (
 )
 
 const (
+	// CREATE organization url
 	CREATE = "org/create"
 )
 
+// Create renders the page to create an organization
 func Create(c *context.Context) {
 	c.Data["Title"] = c.Tr("new_org")
 	c.HTML(200, CREATE)
 }
 
+// CreatePost creates an organization with the body fields
 func CreatePost(c *context.Context, f form.CreateOrg) {
 	c.Data["Title"] = c.Tr("new_org")
 
@@ -32,6 +35,7 @@ func CreatePost(c *context.Context, f form.CreateOrg) {
 		Type:     models.USER_TYPE_ORGANIZATION,
 	}
 
+	// Create organization
 	if err := models.CreateOrganization(org, c.User); err != nil {
 		c.Data["Err_OrgName"] = true
 		switch {

routes/org/setting.go

@@ -13,17 +13,24 @@ import (
 )
 
 const (
-	SETTINGS_OPTIONS  = "org/settings/options"
-	SETTINGS_DELETE   = "org/settings/delete"
+	// SETTINGS_OPTIONS url
+	SETTINGS_OPTIONS = "org/settings/options"
+
+	// SETTINGS_DELETE url
+	SETTINGS_DELETE = "org/settings/delete"
+
+	// SETTINGS_WEBHOOKS url
 	SETTINGS_WEBHOOKS = "org/settings/webhooks"
 )
 
+// Settings shows the organization settings page
 func Settings(c *context.Context) {
 	c.Data["Title"] = c.Tr("org.settings")
 	c.Data["PageIsSettingsOptions"] = true
 	c.HTML(200, SETTINGS_OPTIONS)
 }
 
+// SettingsPost updates organization settings with the body fields
 func SettingsPost(c *context.Context, f form.UpdateOrgSetting) {
 	c.Data["Title"] = c.Tr("org.settings")
 	c.Data["PageIsSettingsOptions"] = true
@@ -74,6 +81,8 @@ func SettingsPost(c *context.Context, f form.UpdateOrgSetting) {
 	org.Website = f.Website
 	org.Location = f.Location
 	org.IsVerified = f.IsVerified
+
+	// Update organization
 	if err := models.UpdateUser(org); err != nil {
 		c.Handle(500, "UpdateUser", err)
 		return
@@ -83,17 +92,22 @@ func SettingsPost(c *context.Context, f form.UpdateOrgSetting) {
 	c.Redirect(c.Org.OrgLink + "/settings")
 }
 
+// SettingsAvatar updates organization avatar
 func SettingsAvatar(c *context.Context, f form.Avatar) {
 	f.Source = form.AVATAR_LOCAL
+
+	// Update avatar
 	if err := user.UpdateAvatarSetting(c, f, c.Org.Organization); err != nil {
 		c.Flash.Error(err.Error())
 	} else {
 		c.Flash.Success(c.Tr("org.settings.update_avatar_success"))
 	}
 
+	// Redirect to "/settings"
 	c.Redirect(c.Org.OrgLink + "/settings")
 }
 
+// SettingsDeleteAvatar deletes organization avatar
 func SettingsDeleteAvatar(c *context.Context) {
 	if err := c.Org.Organization.DeleteAvatar(); err != nil {
 		c.Flash.Error(err.Error())
@@ -102,12 +116,14 @@ func SettingsDeleteAvatar(c *context.Context) {
 	c.Redirect(c.Org.OrgLink + "/settings")
 }
 
+// SettingsDelete deletes an organization
 func SettingsDelete(c *context.Context) {
 	c.Title("org.settings")
 	c.PageIs("SettingsDelete")
 
 	org := c.Org.Organization
 	if c.Req.Method == "POST" {
+		// Check if user is logged in
 		if _, err := models.UserLogin(c.User.Name, c.Query("password"), c.User.LoginSource); err != nil {
 			if errors.IsUserNotExist(err) {
 				c.RenderWithErr(c.Tr("form.enterred_invalid_password"), SETTINGS_DELETE, nil)
@@ -117,6 +133,7 @@ func SettingsDelete(c *context.Context) {
 			return
 		}
 
+		// Delete organization
 		if err := models.DeleteOrganization(org); err != nil {
 			if models.IsErrUserOwnRepos(err) {
 				c.Flash.Error(c.Tr("form.org_still_own_repo"))
@@ -134,6 +151,7 @@ func SettingsDelete(c *context.Context) {
 	c.Success(SETTINGS_DELETE)
 }
 
+// Webhooks shows organization webhooks settings
 func Webhooks(c *context.Context) {
 	c.Data["Title"] = c.Tr("org.settings")
 	c.Data["PageIsSettingsHooks"] = true
@@ -151,7 +169,10 @@ func Webhooks(c *context.Context) {
 	c.HTML(200, SETTINGS_WEBHOOKS)
 }
 
+// DeleteWbhook deletes an organization webhook
 func DeleteWebhook(c *context.Context) {
+
+	// Delete the webhook
 	if err := models.DeleteWebhookOfOrgByID(c.Org.Organization.ID, c.QueryInt64("id")); err != nil {
 		c.Flash.Error("DeleteWebhookByOrgID: " + err.Error())
 	} else {