From 19532d147b431a4fe34f088d6de07891c48e2c5c Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Tue, 1 Sep 2015 18:21:42 -0700 Subject: Escape ` and ' in doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Escape apostrophes and grave accents in docstrings if they are are supposed to stand for themselves and are not quotes. Remove apostrophes from docstring examples like ‘'(calendar-nth-named-day -1 0 10 year)’ that confuse source code with data. Do some other minor docstring fixups as well, e.g., insert a missing close quote. --- lisp/progmodes/verilog-mode.el | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'lisp/progmodes/verilog-mode.el') diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index 76d85c68c99..caae746779e 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -12794,7 +12794,7 @@ Constant signals: is put into the AUTOSENSE list and is not desired, use the AUTO_CONSTANT declaration anywhere in the module (parenthesis are required): - /* AUTO_CONSTANT ( `this_is_really_constant_dont_autosense_it ) */ + /* AUTO_CONSTANT ( \\=`this_is_really_constant_dont_autosense_it ) */ Better yet, use a parameter, which will be understood to be constant automatically. @@ -12810,16 +12810,16 @@ OOps! An example: always @ (/*AS*/) begin - /* AUTO_CONSTANT (`constant) */ - outin = ina | inb | `constant; + /* AUTO_CONSTANT (\\=`constant) */ + outin = ina | inb | \\=`constant; out = outin; end Typing \\[verilog-auto] will make this into: always @ (/*AS*/ina or inb) begin - /* AUTO_CONSTANT (`constant) */ - outin = ina | inb | `constant; + /* AUTO_CONSTANT (\\=`constant) */ + outin = ina | inb | \\=`constant; out = outin; end @@ -12827,7 +12827,7 @@ Note in Verilog 2001, you can often get the same result from the new @* operator. (This was added to the language in part due to AUTOSENSE!) always @* begin - outin = ina | inb | `constant; + outin = ina | inb | \\=`constant; out = outin; end" (save-excursion -- cgit v1.2.3