[comp.soft-sys.andrew] Errors in "menulist.doc"

guy@auspex.auspex.com (Guy Harris) (09/30/90)

There are a number of typos and other errors in "menulist.doc" (for
example, some methods are claimed to have names beginning with "menu_"
rather than "menulist_"):

*** atk/basics/common/menulist.doc.dist	Wed Nov 22 08:51:05 1989
--- atk/basics/common/menulist.doc	Sat Sep 22 23:32:01 1990
***************
*** 198,204 ****
  Menu list entries have the form of: 
  
  
! \example{card name~prioritynumber,item name,~prioritynumber: procedure}
  
  
  Only the item name is required.  Priority numbers are always two digits.  The 
--- 198,204 ----
  Menu list entries have the form of: 
  
  
! \example{card name~prioritynumber,item name~prioritynumber: procedure}
  
  
  Only the item name is required.  Priority numbers are always two digits.  The 
***************
*** 871,878 ****
  
  
  \bold{Usage.}  To look at all the menu items in a menu list, you should call 
! menu_RewindML to set the current item to the first item, and then call 
! menu_NextME until it returns \smaller{FALSE}.  Note that the method only 
  iterates through the menu list; it will not search associated lists, e.g. a 
  stack of cards created by chained menu lists. 
  
--- 871,878 ----
  
  
  \bold{Usage.}  To look at all the menu items in a menu list, you should call 
! menulist_RewindML to set the current item to the first item, and then call 
! menulist_NextME until it returns \smaller{FALSE}.  Note that the method only 
  iterates through the menu list; it will not search associated lists, e.g. a 
  stack of cards created by chained menu lists. 
  
***************
*** 894,900 ****
  
  \bold{Usage.}  You can use this macro to do the stepwise loop after the before 
  list has been rewound.  Warning:  The design of the code for menulists is 
! non-reenterant; if one procedure is iterating over menulists, it must not call 
  another procedure that also iterates over the same menulist.  However, a 
  problem occurs when the iteration variable is in the menulist rather than in 
  the caller.
--- 894,900 ----
  
  \bold{Usage.}  You can use this macro to do the stepwise loop after the before 
  list has been rewound.  Warning:  The design of the code for menulists is 
! non-reentrant; if one procedure is iterating over menulists, it must not call 
  another procedure that also iterates over the same menulist.  However, a 
  problem occurs when the iteration variable is in the menulist rather than in 
  the caller.
***************
*** 933,943 ****
  
  \indexi{Menulist++Rewinding}
  
! \example{#define menu_RewindML(alist)}
  
  
! \leftindent{\bold{Macro description.}  \italic{menu_RewindML} is a macro that 
! "rewinds," or iterates over the menu list chain. 
  
  
  \bold{Usage.}  In a stepwise loop situation, you would use this macro to set 
--- 933,943 ----
  
  \indexi{Menulist++Rewinding}
  
! \example{#define menulist_RewindML(alist)}
  
  
! \leftindent{\bold{Macro description.}  \italic{menulist_RewindML} is a macro 
! that "rewinds," or iterates over the menu list chain. 
  
  
  \bold{Usage.}  In a stepwise loop situation, you would use this macro to set 
***************
*** 949,959 ****
  
  \indexi{ \italic{menulist_RewindBeforeMC}}
  
! \indexi{Menulist++Rewinding before}\example{#define menu_RewindBeforeMC(alist)
  
  }
! \leftindent{\bold{Macro description.}  The \italic{menu_RewindBeforeMC} macro 
! does a rewind on the before menu list chain.  It is used by 
  \italic{menulist_NextBeforeMC}. 
  
  
--- 949,960 ----
  
  \indexi{ \italic{menulist_RewindBeforeMC}}
  
! \indexi{Menulist++Rewinding before}\example{#define 
! menulist_RewindBeforeMC(alist)
  
  }
! \leftindent{\bold{Macro description.}  The \italic{menulist_RewindBeforeMC} 
! macro does a rewind on the before menu list chain.  It is used by 
  \italic{menulist_NextBeforeMC}. 
  
  
***************
*** 967,978 ****
  
  \indexi{ \italic{menulist_RewindAfterMC}}
  
! \indexi{Menulist++Rewinding after}\example{#define menu_RewindAfterMC(alist)}
  
  
! \leftindent{\bold{Macro description.}  The \italic{menu_RewindAfterMC} macro 
! is similar to \italic{RewindBeforeMC }except the rewinding occurs for the 
! after chain.  It is used by \italic{menulist_NextAfterMC}. 
  
  
  \bold{Usage.}  In a stepwise loop situation, you would use this macro to set 
--- 968,980 ----
  
  \indexi{ \italic{menulist_RewindAfterMC}}
  
! \indexi{Menulist++Rewinding after}\example{#define 
! menulist_RewindAfterMC(alist)}
  
  
! \leftindent{\bold{Macro description.}  The \italic{menulist_RewindAfterMC} 
! macro is similar to \italic{RewindBeforeMC }except the rewinding occurs for 
! the after chain.  It is used by \italic{menulist_NextAfterMC}. 
  
  
  \bold{Usage.}  In a stepwise loop situation, you would use this macro to set 
***************
*** 989,995 ****
  \indexi{Menulist++Versio}\example{#define menulist_GetMLVersion(alist)}
  
  \leftindent{
! \bold{Macro description.}  Gets the version number for a menu list.]}
  
  
  
--- 991,997 ----
  \indexi{Menulist++Versio}\example{#define menulist_GetMLVersion(alist)}
  
  \leftindent{
! \bold{Macro description.}  Gets the version number for a menu list.}