Describe function args and clean up titles for proc_mem.stp and task_time.stp

2 files changed, 47 insertions, 25 deletions

diff --git a/tapset/proc_mem.stp b/tapset/proc_mem.stp
index 25a9b8ad..5bb46ca6 100644
--- a/tapset/proc_mem.stp
+++ b/tapset/proc_mem.stp
@@ -51,7 +51,7 @@ function _stp_get_mm_counter_anon_rss(mm:long)
 }
 
 /**
- * sfunction proc_mem_size - Total program virtual memory size in pages.
+ * sfunction proc_mem_size - Total program virtual memory size in pages
  *
  * Description: Returns the total virtual memory size in pages of the
  * current process, or zero when there is no current process or the
@@ -67,7 +67,9 @@ function proc_mem_size:long ()
 %}
 
 /**
- * sfunction proc_mem_size_pid - Total program virtual memory size in pages.
+ * sfunction proc_mem_size_pid - Total program virtual memory size in pages
+ *
+ * @pid: The pid of process to examine
  *
  * Description: Returns the total virtual memory size in pages of the
  * given process, or zero when that process doesn't exist or the
@@ -86,7 +88,7 @@ function proc_mem_size_pid:long (pid:long)
 }
 
 /**
- * sfunction proc_mem_rss - Program resident set size in pages.
+ * sfunction proc_mem_rss - Program resident set size in pages
  *
  * Description: Returns the resident set size in pages of the current
  * process, or zero when there is no current process or the number of
@@ -103,7 +105,9 @@ function proc_mem_rss:long ()
 %}
 
 /**
- * sfunction proc_mem_rss_pid - Program resident set size in pages.
+ * sfunction proc_mem_rss_pid - Program resident set size in pages
+ *
+ * @pid: The pid of process to examine
  *
  * Description: Returns the resident set size in pages of the given
  * process, or zero when the process doesn't exist or the number of
@@ -123,7 +127,7 @@ function proc_mem_rss_pid:long (pid:long)
 }
 
 /**
- * sfunction proc_mem_shr - Program shared pages (from shared mappings).
+ * sfunction proc_mem_shr - Program shared pages (from shared mappings)
  *
  * Description: Returns the shared pages (from shared mappings) of the
  * current process, or zero when there is no current process or the
@@ -139,7 +143,9 @@ function proc_mem_shr:long ()
 %}
 
 /**
- * sfunction proc_mem_shr_pid - Program shared pages (from shared mappings).
+ * sfunction proc_mem_shr_pid - Program shared pages (from shared mappings)
+ *
+ * @pid: The pid of process to examine
  *
  * Description: Returns the shared pages (from shared mappings) of the
  * given process, or zero when the process doesn't exist or the
@@ -158,7 +164,7 @@ function proc_mem_shr_pid:long (pid:long)
 }
 
 /**
- * sfunction proc_mem_txt - Program text (code) size in pages.
+ * sfunction proc_mem_txt - Program text (code) size in pages
  *
  * Description: Returns the current process text (code) size in pages,
  * or zero when there is no current process or the number of pages
@@ -183,7 +189,9 @@ function _stp_mem_txt_adjust:long (start_code:long, end_code:long)
 %}
 
 /**
- * sfunction proc_mem_txt_pid - Program text (code) size in pages.
+ * sfunction proc_mem_txt_pid - Program text (code) size in pages
+ *
+ * @pid: The pid of process to examine
  *
  * Description: Returns the given process text (code) size in pages,
  * or zero when the process doesn't exist or the number of pages
@@ -206,7 +214,7 @@ function proc_mem_txt_pid:long (pid:long)
 }
 
 /**
- * sfunction proc_mem_data - Program data size (data + stack) in pages.
+ * sfunction proc_mem_data - Program data size (data + stack) in pages
  *
  * Description: Returns the current process data size (data + stack)
  * in pages, or zero when there is no current process or the number of
@@ -222,7 +230,9 @@ function proc_mem_data:long ()
 %}
 
 /**
- * sfunction proc_mem_data_pid - Program data size (data + stack) in pages.
+ * sfunction proc_mem_data_pid - Program data size (data + stack) in pages
+ *
+ * @pid: The pid of process to examine
  *
  * Description: Returns the given process data size (data + stack)
  * in pages, or zero when the process doesn't exist or the number of
@@ -245,7 +255,7 @@ function proc_mem_data_pid:long (pid:long)
 }
 
 /**
- * sfunction mem_page_size - Number of bytes in a page for this architecture.
+ * sfunction mem_page_size - Number of bytes in a page for this architecture
  */
 function mem_page_size:long ()
 %{ /* pure */ /* unprivileged */
@@ -263,7 +273,8 @@ function _stp_number_to_string_postfix:string (x:long, y:long, p:string)
 }
 
 /**
- * sfunction bytes_to_string - Human readable string for given bytes.
+ * sfunction bytes_to_string - Human readable string for given bytes
+ *
  * @bytes: Number of bytes to translate.
  *
  * Description: Returns a string representing the number of bytes (up
@@ -296,7 +307,8 @@ function bytes_to_string:string (bytes:long)
 }
 
 /**
- * sfunction pages_to_string - Turns pages into a human readable string.
+ * sfunction pages_to_string - Turns pages into a human readable string
+ *
  * @pages: Number of pages to translate.
  *
  * Description: Multiplies pages by page_size() to get the number of
@@ -309,7 +321,7 @@ function pages_to_string:string (pages:long)
 }
 
 /**
- * sfunction proc_mem_string - Human readable string of current proc memory usage.
+ * sfunction proc_mem_string - Human readable string of current proc memory usage
  *
  * Description: Returns a human readable string showing the size, rss,
  * shr, txt and data of the memory used by the current process.
@@ -326,7 +338,9 @@ function proc_mem_string:string ()
 }
 
 /**
- * sfunction proc_mem_string_pid - Human readable string of process memory usage.
+ * sfunction proc_mem_string_pid - Human readable string of process memory usage
+ *
+ * @pid: The pid of process to examine
  *
  * Description: Returns a human readable string showing the size, rss,
  * shr, txt and data of the memory used by the given process.
@@ -340,4 +354,4 @@ function proc_mem_string_pid:string (pid:long)
                   pages_to_string(proc_mem_shr_pid(pid)),
                   pages_to_string(proc_mem_txt_pid(pid)),
                   pages_to_string(proc_mem_data_pid(pid)));
-}
\ No newline at end of file
+}
diff --git a/tapset/task_time.stp b/tapset/task_time.stp
index c6af10d0..e5aef933 100644
--- a/tapset/task_time.stp
+++ b/tapset/task_time.stp
@@ -24,7 +24,7 @@
 %}
 
 /**
- * sfunction task_utime - User time of the current task.
+ * sfunction task_utime - User time of the current task
  *
  * Description: Returns the user time of the current task in cputime.
  * Does not include any time used by other tasks in this process, nor
@@ -36,7 +36,9 @@ function task_utime:long ()
 %}
 
 /**
- * sfunction task_utime - User time of the given task.
+ * sfunction task_utime - User time of the given task
+ *
+ * @tid: Thread id of the given task
  *
  * Description: Returns the user time of the given task in cputime,
  * or zero if the task doesn't exist.
@@ -53,7 +55,7 @@ function task_utime_tid:long(tid:long)
 }
 
 /**
- * sfunction task_stime - System time of the current task.
+ * sfunction task_stime - System time of the current task
  *
  * Description: Returns the system time of the current task in cputime.
  * Does not include any time used by other tasks in this process, nor
@@ -65,7 +67,9 @@ function task_stime:long ()
 %}
 
 /**
- * sfunction task_stime_tid - System time of the given task.
+ * sfunction task_stime_tid - System time of the given task
+ *
+ * @tid: Thread id of the given task
  *
  * Description: Returns the system time of the given task in cputime,
  * or zero if the task doesn't exist.
@@ -82,7 +86,7 @@ function task_stime_tid:long(tid:long)
 }
 
 /**
- * sfunction cputime_to_msecs - Translates the given cputime into milliseconds.
+ * sfunction cputime_to_msecs - Translates the given cputime into milliseconds
  * @cputime: Time to convert to milliseconds.
  */
 function cputime_to_msecs:long (cputime:long)
@@ -91,7 +95,8 @@ function cputime_to_msecs:long (cputime:long)
 %}
 
 /**
- * sfunction msecs_to_string - Human readable string for given milliseconds.
+ * sfunction msecs_to_string - Human readable string for given milliseconds
+ *
  * @msecs: Number of milliseconds to translate.
  *
  * Description: Returns a string representing the number of
@@ -109,7 +114,8 @@ function msecs_to_string:string (msecs:long)
 }
 
 /**
- * sfunction cputime_to_string - Human readable string for given cputime.
+ * sfunction cputime_to_string - Human readable string for given cputime
+ *
  * @cputime: Time to translate.
  *
  * Description: Equivalent to calling:
@@ -121,7 +127,7 @@ function cputime_to_string:string (cputime:long)
 }
 
 /**
- * sfunction task_time_string - Human readable string of task time usage.
+ * sfunction task_time_string - Human readable string of task time usage
  *
  * Description: Returns a human readable string showing the user and
  * system time the current task has used up to now.  For example
@@ -135,7 +141,9 @@ function task_time_string:string ()
 }
 
 /**
- * sfunction task_time_string_tid - Human readable string of task time usage.
+ * sfunction task_time_string_tid - Human readable string of task time usage
+ *
+ * @tid: Thread id of the given task
  *
  * Description: Returns a human readable string showing the user and
  * system time the given task has used up to now.  For example