changeset 14069:a45a97ebdf1c

(Fdocumentation, Fdocumentation_property, Fsubstitute_command_keys): Harmonize arguments with documentation.

--- a/src/doc.c	Tue Jan 09 00:31:17 1996 +0000
+++ b/src/doc.c	Tue Jan 09 00:31:22 1996 +0000
@@ -263,7 +263,7 @@
 
 DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0,
   "Return the documentation string of FUNCTION.\n\
-Unless a non-nil second argument is given, the\n\
+Unless a non-nil second argument RAW is given, the\n\
 string is passed through `substitute-command-keys'.")
   (function, raw)
      Lisp_Object function, raw;
@@ -350,14 +350,14 @@
   "Return the documentation string that is SYMBOL's PROP property.\n\
 This is like `get', but it can refer to strings stored in the\n\
 `etc/DOC' file; and if the value is a string, it is passed through\n\
-`substitute-command-keys'.  A non-nil third argument avoids this\n\
+`substitute-command-keys'.  A non-nil third argument RAW avoids this\n\
 translation.")
-  (sym, prop, raw)
-     Lisp_Object sym, prop, raw;
+  (symbol, prop, raw)
+     Lisp_Object symbol, prop, raw;
 {
   register Lisp_Object tem;
 
-  tem = Fget (sym, prop);
+  tem = Fget (symbol, prop);
   if (INTEGERP (tem))
     tem = get_doc_string (XINT (tem) > 0 ? tem : make_number (- XINT (tem)));
   else if (CONSP (tem))
@@ -528,8 +528,8 @@
 as the keymap for future \\=\\[COMMAND] substrings.\n\
 \\=\\= quotes the following character and is discarded;\n\
 thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.")
-  (str)
-     Lisp_Object str;
+  (string)
+     Lisp_Object string;
 {
   unsigned char *buf;
   int changed = 0;
@@ -545,28 +545,28 @@
   Lisp_Object name;
   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
 
-  if (NILP (str))
+  if (NILP (string))
     return Qnil;
 
-  CHECK_STRING (str, 0);
+  CHECK_STRING (string, 0);
   tem = Qnil;
   keymap = Qnil;
   name = Qnil;
-  GCPRO4 (str, tem, keymap, name);
+  GCPRO4 (string, tem, keymap, name);
 
   /* KEYMAP is either nil (which means search all the active keymaps)
      or a specified local map (which means search just that and the
      global map).  If non-nil, it might come from Voverriding_local_map,
-     or from a \\<mapname> construct in STR itself..  */
+     or from a \\<mapname> construct in STRING itself..  */
   keymap = current_kboard->Voverriding_terminal_local_map;
   if (NILP (keymap))
     keymap = Voverriding_local_map;
 
-  bsize = XSTRING (str)->size;
+  bsize = XSTRING (string)->size;
   bufp = buf = (unsigned char *) xmalloc (bsize);
 
-  strp = (unsigned char *) XSTRING (str)->data;
-  while (strp < (unsigned char *) XSTRING (str)->data + XSTRING (str)->size)
+  strp = (unsigned char *) XSTRING (string)->data;
+  while (strp < (unsigned char *) XSTRING (string)->data + XSTRING (string)->size)
     {
       if (strp[0] == '\\' && strp[1] == '=')
 	{
@@ -584,15 +584,15 @@
 	  strp += 2;		/* skip \[ */
 	  start = strp;
 
-	  while ((strp - (unsigned char *) XSTRING (str)->data
-		  < XSTRING (str)->size)
+	  while ((strp - (unsigned char *) XSTRING (string)->data
+		  < XSTRING (string)->size)
 		 && *strp != ']')
 	    strp++;
 	  length = strp - start;
 	  strp++;		/* skip ] */
 
 	  /* Save STRP in IDX.  */
-	  idx = strp - (unsigned char *) XSTRING (str)->data;
+	  idx = strp - (unsigned char *) XSTRING (string)->data;
 	  tem = Fintern (make_string (start, length), Qnil);
 	  tem = Fwhere_is_internal (tem, keymap, Qt, Qnil);
 
@@ -631,15 +631,15 @@
 	  strp += 2;		/* skip \{ or \< */
 	  start = strp;
 
-	  while ((strp - (unsigned char *) XSTRING (str)->data
-		  < XSTRING (str)->size)
+	  while ((strp - (unsigned char *) XSTRING (string)->data
+		  < XSTRING (string)->size)
 		 && *strp != '}' && *strp != '>')
 	    strp++;
 	  length = strp - start;
 	  strp++;			/* skip } or > */
 
 	  /* Save STRP in IDX.  */
-	  idx = strp - (unsigned char *) XSTRING (str)->data;
+	  idx = strp - (unsigned char *) XSTRING (string)->data;
 
 	  /* Get the value of the keymap in TEM, or nil if undefined.
 	     Do this while still in the user's current buffer
@@ -682,8 +682,8 @@
 	  buf = new;
 	  bcopy (start, bufp, length);
 	  bufp += length;
-	  /* Check STR again in case gc relocated it.  */
-	  strp = (unsigned char *) XSTRING (str)->data + idx;
+	  /* Check STRING again in case gc relocated it.  */
+	  strp = (unsigned char *) XSTRING (string)->data + idx;
 	}
       else			/* just copy other chars */
 	*bufp++ = *strp++;
@@ -692,7 +692,7 @@
   if (changed)			/* don't bother if nothing substituted */
     tem = make_string (buf, bufp - buf);
   else
-    tem = str;
+    tem = string;
   xfree (buf);
   RETURN_UNGCPRO (tem);
 }