Add code comments

Ahoo-Wang · Mar 20, 2023 · 76cba0a · 76cba0a
1 parent 4481872
commit 76cba0a
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/cosec-api/src/main/kotlin/me/ahoo/cosec/api/permission/AppPermission.kt b/cosec-api/src/main/kotlin/me/ahoo/cosec/api/permission/AppPermission.kt
@@ -1,5 +1,8 @@
 package me.ahoo.cosec.api.permission
 
+/**
+ * App permissions metadata.
+ */
 interface AppPermission {
     val id: String
     val groups: List<PermissionGroup>

diff --git a/cosec-api/src/main/kotlin/me/ahoo/cosec/api/permission/Permission.kt b/cosec-api/src/main/kotlin/me/ahoo/cosec/api/permission/Permission.kt
@@ -15,6 +15,9 @@ package me.ahoo.cosec.api.permission
 
 import me.ahoo.cosec.api.policy.Statement
 
+/**
+ * Permission metadata.
+ */
 interface Permission : Statement {
     val id: String
     val description: String

diff --git a/cosec-api/src/main/kotlin/me/ahoo/cosec/api/permission/PermissionGroup.kt b/cosec-api/src/main/kotlin/me/ahoo/cosec/api/permission/PermissionGroup.kt
@@ -15,6 +15,9 @@ package me.ahoo.cosec.api.permission
 
 import me.ahoo.cosec.api.Named
 
+/**
+ * Permission group.
+ */
 interface PermissionGroup : Named {
     override val name: String
     val description: String

diff --git a/cosec-api/src/main/kotlin/me/ahoo/cosec/api/permission/RolePermission.kt b/cosec-api/src/main/kotlin/me/ahoo/cosec/api/permission/RolePermission.kt
@@ -13,6 +13,9 @@
 
 package me.ahoo.cosec.api.permission
 
+/**
+ * Role Permissions.
+ */
 interface RolePermission {
     /**
      * role id