From c4f059793a050c5a0ab8d30d5e2aafb797844d65 Mon Sep 17 00:00:00 2001
From: holan20180123 <liyuchun@easycorp.ltd>
Date: Wed, 25 Aug 2021 13:21:51 +0800
Subject: [PATCH]  * Finish task #41549.

---
 module/doc/js/common.js | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

diff --git a/module/doc/js/common.js b/module/doc/js/common.js
index 1d8d880e7d..625015a587 100644
--- a/module/doc/js/common.js
+++ b/module/doc/js/common.js
@@ -1,9 +1,24 @@
+/**
+ * Load modules by libID.
+ *
+ * @param  int    $libID
+ * @access public
+ * @return void
+ */
 function loadModules(libID)
 {
     link = createLink('doc', 'ajaxGetModules', 'libID=' + libID);
     $('#moduleBox').load(link, function(){$('#moduleBox').find('select').chosen()});
 }
 
+/**
+ * Toggle acl.
+ *
+ * @param  string $acl
+ * @param  string $type
+ * @access public
+ * @return void
+ */
 function toggleAcl(acl, type)
 {
     if(acl == 'custom')
@@ -27,6 +42,13 @@ function toggleAcl(acl, type)
     }
 }
 
+/**
+ * Load doc module by libID.
+ *
+ * @param  int    $libID
+ * @access public
+ * @return void
+ */
 function loadDocModule(libID)
 {
     link = createLink('doc', 'ajaxGetChild', 'libID=' + libID);
@@ -38,6 +60,13 @@ function loadDocModule(libID)
     });
 }
 
+/**
+ * Set cookie of browse type and reload.
+ *
+ * @param  type $type
+ * @access public
+ * @return void
+ */
 function setBrowseType(type)
 {
     $.cookie('browseType', type, {expires:config.cookieLife, path:config.webRoot});
@@ -46,7 +75,7 @@ function setBrowseType(type)
 
 $(document).ready(function()
 {
-    /* hide #module chosen dropdown on #lib dropdown show */
+    /* Hide #module chosen dropdown on #lib dropdown show */
     $('#lib').on('chosen:showing_dropdown', function()
     {
         $('#module').trigger('chosen:close');
@@ -85,7 +114,7 @@ $(document).ready(function()
 
     var NAME = 'zui.splitRow'; // model name
 
-    /* The SplitRow model class */
+    /* The SplitRow model class. */
     var SplitRow = function(element, options)
     {
         var that = this;