From maintainers-request at octave dot org Wed Jun 15 06:32:29 2005 Subject: Documentation patch From: Bill Denney To: maintainers at octave dot org Date: Wed, 15 Jun 2005 07:31:42 -0400 (EDT) This message is in MIME format. The first part should be readable text, while the remaining parts are likely unreadable without MIME-aware tools. --8323328-135630961-1118835102=:4193 Content-Type: TEXT/PLAIN; charset=US-ASCII; format=flowed Here is a patch adding more documentation to many of the functions in help.cc. I didn't know what some of the functions do, so I didn't add any docs for those (perhaps with the exception of some "See also"s). Changelog: 2005-06-15 Bill Denney * src/help.cc: added more documentation. Bill -- "To steal ideas from one person is plagiarism; to steal from many is research." -- Steven Wright --8323328-135630961-1118835102=:4193 Content-Type: TEXT/PLAIN; charset=US-ASCII; name=help-doc-patch Content-Transfer-Encoding: BASE64 Content-ID: Content-Description: Content-Disposition: attachment; filename=help-doc-patch LS0tIC4uL29jdGF2ZS0yLjEuNzEvc3JjL2hlbHAuY2MJMjAwNS0wNS0wMiAw NzoxNzoxMi4wMDAwMDAwMDAgLTA0MDANCisrKyBzcmMvaGVscC5jYwkyMDA1 LTA2LTE1IDA3OjI2OjUwLjk0MzE0MDg3MiAtMDQwMA0KQEAgLTIyNCw2NCAr MjI0LDEyMyBAQA0KIHN0YXRpYyBoZWxwX2xpc3Qga2V5d29yZHNbXSA9DQog ew0KICAgeyAiYWxsX3ZhX2FyZ3MiLA0KLSAgICAiUGFzcyBhbGwgdW5uYW1l ZCBhcmd1bWVudHMgdG8gYW5vdGhlciBmdW5jdGlvbiBjYWxsLiIsIH0sDQor ICAgICJQYXNzIGFsbCB1bm5hbWVkIGFyZ3VtZW50cyB0byBhbm90aGVyIGZ1 bmN0aW9uIGNhbGwuXG5cDQorXG5cDQorU2VlIGFsc286IHZhcmFyZ2luLCB2 YXJhcmdvdXQiLCB9LA0KIA0KICAgeyAiYnJlYWsiLA0KLSAgICAiRXhpdCB0 aGUgaW5uZXJtb3N0IGVuY2xvc2luZyBkbywgd2hpbGUgb3IgZm9yIGxvb3Au IiwgfSwNCisgICAgIkV4aXQgdGhlIGlubmVybW9zdCBlbmNsb3NpbmcgZG8s IHdoaWxlIG9yIGZvciBsb29wLlxuXA0KK1xuXA0KK1NlZSBhbHNvOiBjb250 aW51ZSwgcmV0dXJuIiwgfSwNCiANCiAgIHsgImNhc2UiLA0KICAgICAiQSBj YXNlIHN0YXRlbWVudCBpbiBhbiBzd2l0Y2guIE9jdGF2ZSBjYXNlcyBhcmUg ZXhjbHVzaXZlIGFuZCBkbyBub3RcblwNCiBmYWxsLXRocm91Z2ggYXMgZG8g Qy1sYW5ndWFnZSBjYXNlcy4gQSBzd2l0Y2ggc3RhdGVtZW50IG11c3QgaGF2 ZSBhdCBsZWFzdFxuXA0KLW9uZSBjYXNlLiIsfSwNCitvbmUgY2FzZS5cblwN CitcblwNCitTZWUgYWxzbzogc3dpdGNoIix9LA0KIA0KICAgeyAiY2F0Y2gi LA0KLSAgICAiYmVnaW4gdGhlIGNsZWFudXAgcGFydCBvZiBhIHRyeS1jYXRj aCBibG9jayIsIH0sDQorICAgICJCZWdpbiB0aGUgY2xlYW51cCBzZWN0aW9u IG9mIGEgdHJ5LWNhdGNoIGJsb2NrLiAgVGhpcyBwYXJ0IG9mIHRoZSBibG9j a1xuXA0KK2lzIG5vdCBleGVjdXRlZCB1bmxlc3Mgc29tZSBwYXJ0IG9mIHRo ZSB0cnkgc2VjdGlvbiBvZiB0aGUgYmxvY2sgZmFpbHMuXG5cDQorXG5cDQor V0FSTklORzogSWYgdGhlcmUgaXMgYSBmYWlsdXJlIG9mIGEgbGluZSBpbiB0 aGUgdHJ5IHNlY3Rpb24sIHRoZSByZXN1bHRzXG5cDQorb2YgdGhlIHNlY3Rp b24gdXAgdG8gdGhlIHBvaW50IG9mIHRoZSBlcnJvciB3aWxsIGJlIGV4ZWN1 dGVkIGFuZCB0aGVuIHRoZVxuXA0KK2NhdGNoIHNlY3Rpb24gd2lsbCBiZSBl eGVjdXRlZC5cblwNCitcblwNCitTZWUgYWxzbzogZXJyb3IsIHRyeSIsIH0s DQogDQogICB7ICJjb250aW51ZSIsDQotICAgICJKdW1wIHRvIHRoZSBlbmQg b2YgdGhlIGlubmVybW9zdCBlbmNsb3NpbmcgZG8sIHdoaWxlIG9yIGZvciBs b29wLiIsIH0sDQorICAgICJKdW1wIHRvIHRoZSBlbmQgb2YgdGhlIGlubmVy bW9zdCBlbmNsb3NpbmcgZG8sIHdoaWxlIG9yIGZvciBsb29wLlxuXA0KK1xu XA0KK1NlZSBhbHNvOiBicmVhaywgZG8sIGZvciwgcmV0dXJuLCB3aGlsZSIs IH0sDQogDQogICB7ICJkbyIsDQogICAgICJCZWdpbiBhIGRvLXVudGlsIGxv b3AuIFRoaXMgZGlmZmVycyBmcm9tIGEgZG8td2hpbGUgbG9vcCBpbiB0aGF0 IHRoZVxuXA0KLWJvZHkgb2YgdGhlIGxvb3AgaXMgZXhlY3V0ZWQgYXQgbGVh c3Qgb25jZS4iLH0sDQorYm9keSBvZiB0aGUgbG9vcCBpcyBleGVjdXRlZCBh dCBsZWFzdCBvbmNlLlxuXA0KK0V4YW1wbGUgKHRoZSBmaW5hbCB2YWx1ZSBv ZiBhIHdpbGwgYmUgNCk6XG5cDQorXG5cDQorYSA9IDFcblwNCitkb1xuXA0K KyAgYSA9IGEgKyAxXG5cDQordW50aWwgYSA+IDNcblwNCitcblwNCitTZWUg YWxzbzogZm9yLCB3aGlsZSIsfSwNCiANCiAgIHsgImVsc2UiLA0KLSAgICAi QWx0ZXJuYXRlIGFjdGlvbiBmb3IgYW4gaWYgYmxvY2suIiwgfSwNCisgICAg IkFsdGVybmF0ZSBhY3Rpb24gZm9yIGFuIGlmIGJsb2NrLlxuXA0KK1xuXA0K K1NlZSBhbHNvOiBpZiIsIH0sDQogDQogICB7ICJlbHNlaWYiLA0KLSAgICAi QWx0ZXJuYXRlIGNvbmRpdGlvbmFsIHRlc3QgZm9yIGFuIGlmIGJsb2NrLiIs IH0sDQorICAgICJBbHRlcm5hdGUgY29uZGl0aW9uYWwgdGVzdCBmb3IgYW4g aWYgYmxvY2suXG5cDQorXG5cDQorU2VlIGFsc286IGlmIiwgfSwNCiANCiAg IHsgImVuZCIsDQotICAgICJNYXJrIHRoZSBlbmQgb2YgYW55IGZvciwgaWYs IGRvLCB3aGlsZSwgb3IgZnVuY3Rpb24gYmxvY2suIiwgfSwNCisgICAgIk1h cmsgdGhlIGVuZCBvZiBhbnkgZm9yLCBpZiwgZG8sIHRyeSwgd2hpbGUsIG9y IGZ1bmN0aW9uIGJsb2NrLiIsIH0sDQogDQogICB7ICJlbmRfdHJ5X2NhdGNo IiwNCi0gICAgIk1hcmsgdGhlIGVuZCBvZiBhbiB0cnktY2F0Y2ggYmxvY2su IiwgfSwgDQorICAgICJNYXJrIHRoZSBlbmQgb2YgYW4gdHJ5LWNhdGNoIGJs b2NrLlxuXA0KK1xuXA0KK1NlZSBhbHNvOiB0cnkiLCB9LCANCiANCiAgIHsg ImVuZF91bndpbmRfcHJvdGVjdCIsDQotICAgICJNYXJrIHRoZSBlbmQgb2Yg YW4gdW53aW5kX3Byb3RlY3QgYmxvY2suIiwgfSwgDQorICAgICJNYXJrIHRo ZSBlbmQgb2YgYW4gdW53aW5kX3Byb3RlY3QgYmxvY2suXG5cDQorXG5cDQor U2VlIGFsc286IHVud2luZF9wcm90ZWN0IiwgfSwgDQogDQogICB7ICJlbmRm b3IiLA0KLSAgICAiTWFyayB0aGUgZW5kIG9mIGEgZm9yIGxvb3AuIiwgfSwN CisgICAgIk1hcmsgdGhlIGVuZCBvZiBhIGZvciBsb29wLlxuXA0KK1xuXA0K K1NlZSBhbHNvOiBmb3IiLCB9LA0KIA0KICAgeyAiZW5kZnVuY3Rpb24iLA0K LSAgICAiTWFyayB0aGUgZW5kIG9mIGEgZnVuY3Rpb24uIiwgfSwNCisgICAg Ik1hcmsgdGhlIGVuZCBvZiBhIGZ1bmN0aW9uLlxuXA0KK1xuXA0KK1NlZSBh bHNvOiBmdW5jdGlvbiIsIH0sDQogDQogICB7ICJlbmRpZiIsDQotICAgICJN YXJrIHRoZSBlbmQgb2YgYW4gaWYgYmxvY2suIiwgfSwNCisgICAgIk1hcmsg dGhlIGVuZCBvZiBhbiBpZiBibG9jay5cblwNCitcblwNCitTZWUgYWxzbzog aWYiLCB9LA0KIA0KICAgeyAiZW5kc3dpdGNoIiwNCi0gICAgIk1hcmsgdGhl IGVuZCBvZiBhIHN3aXRjaCBibG9jay4iLCB9LA0KKyAgICAiTWFyayB0aGUg ZW5kIG9mIGEgc3dpdGNoIGJsb2NrLlxuXA0KK1xuXA0KK1NlZSBhbHNvOiBz d2l0Y2giLCB9LA0KIA0KICAgeyAiZW5kd2hpbGUiLA0KLSAgICAiTWFyayB0 aGUgZW5kIG9mIGEgd2hpbGUgbG9vcC4iLCB9LA0KKyAgICAiTWFyayB0aGUg ZW5kIG9mIGEgd2hpbGUgbG9vcC5cblwNCitcblwNCitTZWUgYWxzbzogd2hp bGUiLCB9LA0KIA0KICAgeyAiZm9yIiwNCi0gICAgIkJlZ2luIGEgZm9yIGxv b3AuIiwgfSwNCisgICAgIkJlZ2luIGEgZm9yIGxvb3AuXG5cDQorXG5cDQor VGhpcyBwcm92aWRlcyBhIG1ldGhvZCBmb3IgbG9vcGluZyBvdmVyIGFsbCB2 YWx1ZXMgb2YgYW4gYXJyYXkuXG5cDQorXG5cDQorRXhhbXBsZTpcblwNCitm b3IgaSA9IDE6NVxuXA0KKyAgaVxuXA0KK2VuZGZvclxuXA0KK1xuXA0KK1Nl ZSBhbHNvOiBkbywgd2hpbGUiLCB9LA0KIA0KICAgeyAiZnVuY3Rpb24iLA0K LSAgICAiQmVnaW4gYSBmdW5jdGlvbiBib2R5LiIsIH0sDQorICAgICJCZWdp biBhIGZ1bmN0aW9uIGJvZHkuICBUaGlzIGtleXdvcmQgYWxsb3dzIHlvdSB0 byBkZWZpbmUgZnVuY3Rpb25zXG5cDQoraW4gdGhlIGZvcm1hdFxuXA0KK2Z1 bmN0aW9uIFtvdXRwdXRfYXJnMSwgb3V0cHV0X2FyZzJdID0gZnVuY3Rpb24o aW5wdXRfYXJnMSwgaW5wdXRfYXJnMilcblwNCit3aGVyZSBhbiBhcmJpdHJh cnkgbnVtYmVyICh6ZXJvIG9yIG1vcmUpIG9mIGlucHV0IGFuZCBvdXRwdXQg YXJndWVtZW50c1xuXA0KK21heSBiZSBzcGVjaWZpZWQgYW5kIGEgdmFyaWFi bGUgbnVtYmVyIG1heSBiZSBzcGVjaWZpZWQgYnkgdXNpbmcgdGhlXG5cDQor dmFyYXJnaW4gYW5kIHZhcmFyZ291dCBrZXl3b3Jkcy5cblwNCitcblwNCitT ZWUgYWxzbzogdmFyYXJnaW4sIHZhcmFyZ291dCIsIH0sDQogDQogICB7ICJn bG9iYWwiLA0KLSAgICAiRGVjbGFyZSB2YXJpYWJsZXMgdG8gaGF2ZSBnbG9i YWwgc2NvcGUuIiwgfSwNCisgICAgIkRlY2xhcmUgdmFyaWFibGVzIHRvIGhh dmUgZ2xvYmFsIHNjb3BlLlxuXA0KK1xuXA0KK1NlZSBhbHNvOiBwZXJzaXN0 ZW50LCBzdGF0aWMiLCB9LA0KIA0KICAgeyAiZ3Bsb3QiLA0KICAgICAiUHJv ZHVjZSAyLUQgcGxvdHMgdXNpbmcgZ251cGxvdC1saWtlIGNvbW1hbmQgc3lu dGF4LiIsIH0sDQpAQCAtMjkwLDMxICszNDksNzYgQEANCiAgICAgIlByb2R1 Y2UgMy1EIHBsb3RzIHVzaW5nIGdudXBsb3QtbGlrZSBjb21tYW5kIHN5bnRh eC4iLCB9LA0KIA0KICAgeyAiaWYiLA0KLSAgICAiQmVnaW4gYW4gaWYgYmxv Y2suIiwgfSwNCisgICAgIkJlZ2luIGFuIGlmIGJsb2NrLlxuXA0KK1xuXA0K K1RoaXMgZnVuY3Rpb24gYWxsb3dzIGNvbmRpdGlvbmFsIGxvZ2ljIHRvIGJl IHBlcmZvcm1lZCBvZiB0aGUgZm9ybTpcblwNCitcblwNCitpZiAoYm9vbGVh biBvcGVyYXRvcilcblwNCisgIHN0YXRlbWVudHNcblwNCitlbHNlaWYgKGJv b2xlYW4gb3BlcmF0b3IpXG5cDQorICBzdGF0ZW1lbnRzXG5cDQorLi4uXG5c DQorZWxzZVxuXA0KKyAgc3RhdGVtZW50c1xuXA0KK2VuZGlmXG5cDQorXG5c DQorVGhlIGJvb2xlYW4gb3BlcmF0b3IgbWF5IGJlIGEgc3RhdGVtZW50IG9m IHRoZSBmb3JtIFwiYSA9PSBiXCIgb3IgYW55XG5cDQorc3RhdGVtZW50IG9y IGZ1bmN0aW9uIHRoYXQgY2FuIGJlIGV2YWx1YXRlZCB0byBhIG5vbi16ZXJv IHJlc3VsdC5cblwNCitcblwNCitTZWUgYWxzbzogYWxsLCBhbnksIHN3aXRj aCIsIH0sDQogDQogICB7ICJvdGhlcndpc2UiLA0KLSAgICAiVGhlIGRlZmF1 bHQgc3RhdGVtZW50IGluIGEgc3dpdGNoIGJsb2NrLiIsIH0sDQorICAgICJU aGUgZGVmYXVsdCBzdGF0ZW1lbnQgaW4gYSBzd2l0Y2ggYmxvY2suXG5cDQor XG5cDQorU2VlIGFsc286IHN3aXRjaCIsIH0sDQogDQogICB7ICJwZXJzaXN0 ZW50IiwNCi0gICAgIkRlY2xhcmUgdmFyaWFibGVzIGFzIHBlcnNpc3RlbnQu IiwgfSwNCisgICAgIkRlY2xhcmUgdmFyaWFibGVzIGFzIHBlcnNpc3RlbnQu XG5cDQorXG5cDQorU2VlIGFsc286IGdsb2JhbCwgc3RhdGljIiwgfSwNCiAN CiAgIHsgInJlcGxvdCIsDQogICAgICJSZXBsb3QgYSBncmFwaGljLiIsIH0s DQogDQogICB7ICJyZXR1cm4iLA0KLSAgICAiUmV0dXJuIGZyb20gYSBmdW5j dGlvbi4iLCB9LA0KKyAgICAiUmV0dXJuIGZyb20gYSBmdW5jdGlvbi5cblwN CitcblwNCitUaGlzIG1heSBiZSB1c2VkIHRvIHJldHVybiBmcm9tIGEgZnVu Y3Rpb24gYmVmb3JlIHRoZSBlbmQgb2YgdGhlIGZ1bmN0aW9uXG5cDQord291 bGQgb3RoZXJ3aXNlIG9jY3VyLlxuXA0KK1xuXA0KK1NlZSBhbHNvOiBicmVh ayIsIH0sDQogDQogICB7ICJzdGF0aWMiLA0KLSAgICAiRGVjbGFyZSB2YXJp YWJsZXMgYXMgcGVyc2lzdGVudC4iLCB9LA0KKyAgICAiRGVjbGFyZSB2YXJp YWJsZXMgYXMgcGVyc2lzdGVudCB3aXRoaW4gYSBmdW5jdGlvbi5cblwNCitc blwNCitTZWUgYWxzbzogZ2xvYmFsLCBwZXJzaXN0ZW50IiwgfSwNCiANCiAg IHsgInN3aXRjaCIsDQotICAgICJCZWdpbiBhIHN3aXRjaCBzdGF0ZW1lbnQu Iix9LA0KKyAgICAiQmVnaW4gYSBzd2l0Y2ggc3RhdGVtZW50LlxuXA0KK1xu XA0KK1NlZSBhbHNvOiBpZiIsfSwNCiANCiAgIHsgInRyeSIsDQotICAgICJC ZWdpbiBhIHRyeS1jYXRjaCBibG9jay4iLCB9LCANCisgICAgIkJlZ2luIGEg dHJ5LWNhdGNoIGJsb2NrLlxuXA0KK1xuXA0KK1RoaXMgYmxvY2sgYWxsb3dz IHlvdSB0byBjYXRjaCBlcnJvcnMgYW5kIGV4ZWN1dGUgYWx0ZXJuYXRlIGNv ZGUgaW4gY2FzZVxuXA0KK29mIGFuIGVycm9yLiAgSWYgdGhlcmUgaXMgbm8g ZXJyb3IgaW4gdGhlIHRyeSBzZWN0aW9uLCB0aGVuIHRoZSBjYXRjaFxuXA0K K3NlY3Rpb24gd2lsbCBub3QgYmUgZXhlY3V0ZWQuXG5cDQorXG5cDQorRXhh bXBsZTpcblwNCit0cnlcblwNCisgIGEgPSAwO1xuXA0KKyAgZXJyb3IgKCdO b3cgZ28gdG8gY2F0Y2gnKTtcblwNCitjYXRjaFxuXA0KKyAgYiA9IDFcblwN CitlbmRfdHJ5X2NhdGNoXG5cDQorXG5cDQorU2VlIGFsc286IGNhdGNoLCBl cnJvciIsIH0sIA0KIA0KICAgeyAidW50aWwiLA0KLSAgICAiRW5kIGEgZG8t dW50aWwgbG9vcC4iLH0sDQorICAgICJFbmQgYSBkby11bnRpbCBsb29wLlxu XA0KK1xuXA0KK1NlZSBhbHNvOiBkbyIsfSwNCiANCiAgIHsgInVud2luZF9w cm90ZWN0IiwNCiAgICAgIkJlZ2luIGFuIHVud2luZF9wcm90ZWN0IGJsb2Nr LiIsIH0sIA0KQEAgLTMyMywxMyArNDI3LDM0IEBADQogICAgICJCZWdpbiB0 aGUgY2xlYW51cCBzZWN0aW9uIG9mIGFuIHVud2luZF9wcm90ZWN0IGJsb2Nr LiIsIH0sIA0KIA0KICAgeyAidmFyYXJnaW4iLA0KLSAgICAiUGFzcyBhbiBh cmJpdHJhcnkgbnVtYmVyIG9mIGFyZ3VtZW50cyBpbnRvIGEgZnVuY3Rpb24u Iix9LA0KKyAgICAiUGFzcyBhbiBhcmJpdHJhcnkgbnVtYmVyIG9mIGFyZ3Vt ZW50cyBpbnRvIGEgZnVuY3Rpb24uICBUaGUgYXJndW1lbnRzXG5cDQorYXJl IHBhc3NlZCBpbiBhcyBhIGNlbGwgYXJyYXkuXG5cDQorXG5cDQorRXhhbXBs ZTpcblwNCitmdW5jdGlvbiBbYSwgdmFyYXJnb3V0XSA9IGZvbyhiLCB2YXJh cmdpbilcblwNCitcblwNCitTZWUgYWxzbzogbmFyZ2luLCBuYXJnb3V0LCB2 YXJhcmdvdXQiLH0sDQogDQogICB7ICJ2YXJhcmdvdXQiLA0KLSAgICAiUGFz cyBhbiBhcmJpdHJhcnkgbnVtYmVyIG9mIGFyZ3VtZW50cyBvdXQgb2YgYSBm dW5jdGlvbi4iLH0sDQorICAgICJQYXNzIGFuIGFyYml0cmFyeSBudW1iZXIg b2YgYXJndW1lbnRzIG91dCBvZiBhIGZ1bmN0aW9uLiAgVGhlIGFyZ3VtZW50 c1xuXA0KK2FyZSBwYXNzZWQgb3V0IGFzIGEgY2VsbCBhcnJheS5cblwNCitc blwNCitFeGFtcGxlOlxuXA0KK2Z1bmN0aW9uIFthLCB2YXJhcmdvdXRdID0g Zm9vKGIsIHZhcmFyZ2luKVxuXA0KK1xuXA0KK1NlZSBhbHNvOiBuYXJnaW4s IG5hcmdvdXQsIHZhcmFyZ2luIix9LA0KIA0KICAgeyAid2hpbGUiLA0KLSAg ICAiQmVnaW4gYSB3aGlsZSBsb29wLiIsIH0sDQorICAgICJCZWdpbiBhIHdo aWxlIGxvb3AuICBUaGlzIHdpbGwgbm90IGV4ZWN1dGUgb25jZSBpZiB0aGUg Y29uZGl0aW9uIGlzXG5cDQorbm90IG1ldCBpbiBjb250cmFzdCB0byBhIGRv IGxvb3AuXG5cDQorXG5cDQorRXhhbXBsZTpcblwNCitpID0gMDtcblwNCit3 aGlsZSAoaSA8IDMpXG5cDQorICBpID0gaSArIDFcblwNCitlbmR3aGlsZVxu XA0KK1xuXA0KK1NlZSBhbHNvOiBkbywgZm9yIiwgfSwNCiANCiAgIHsgMCwg MCwgfSwNCiB9Ow0K --8323328-135630961-1118835102=:4193--