#136 Macro Natural Docs support

[StevenAZ]

In the code below, mousing over "DO_IT" in module m() doesn't give any natural docs information. It does give the definition of the macro.

What is preferred (1, the second or both?)

I can see where in most usage cases I just want to know that the the definition of NUM_PINS is 3, but when you have a complex macro, having some help on what the macro does would be more useful than the actual definition of the macro.

[StevenAZ]

~~~~
/
* Macro: DO_IT (arg1, arg2)
* This function will display args 1 and 2
*
* Arguments:
* arg1 - String - The first message to display
* arg2 - integer - The error count

* Example:
* `DO_IT ("There is an error somewhere", 5);
/

`define DO_IT(arg1,arg2)\ $display (arg1);\ $display (arg2);

module m();
`DO_IT (arg1,
arg2);
endmodule

[Erik Jessen]

I very much agree on examples. Look at svunit for testing

On Feb 22, 2018 10:06 AM, "StevenAZ" stevenaz@users.sourceforge.net wrote:

/
* Macro: DO_IT (arg1, arg2)
* This function will display args 1 and 2

* Arguments:
* arg1 - String - The first message to display
* arg2 - integer - The error count

* Example:
* DO_IT ("There is an error somewhere", 5); */define DO_IT(arg1,arg2)\ $display (arg1);\ $display (arg2);

module m();
`DO_IT (arg1,
arg2);
endmodule

---

[feature-requests:#136] Macro Natural Docs support

Status: open
Group: Next_Release_(example)
Created: Thu Feb 22, 2018 05:06 PM UTC by StevenAZ
Last Updated: Thu Feb 22, 2018 05:06 PM UTC
Owner: nobody

In the code below, mousing over "DO_IT" in module m() doesn't give any
natural docs information. It does give the definition of the macro.

What is preferred (1, the second or both?)

I can see where in most usage cases I just want to know that the the
definition of NUM_PINS is 3, but when you have a complex macro, having some
help on what the macro does would be more useful than the actual definition
of the macro.

---

Sent from sourceforge.net because you indicated interest in <
https://sourceforge.net/p/sveditor/feature-requests/136/>

To unsubscribe from further messages, please visit <
https://sourceforge.net/auth/subscriptions/>

[StevenAZ]

I took a look at the C++ implementation in Eclipse. Looks like the implementation is to simply expand the macro when you mouse over it, not to offer up any natural docs like information.