3

In Mathematica, when you hover any a built-in function, a small window with 2 symbols appears (as in the third paragraph of this reference page, see picture): clicking on the former one gives you a quick description of the function ("summary"), whereas the latter is a link to a detailed page on the function ("documentation").

My question is if it's possible to do exactly the same on a function defined by the user.


(source: wolfram.com)

Community
  • 1
Oscar Charles
  • 53
  • 4
  • Welcome to Mathematica.SE! I suggest the following: 1) As you receive help, try to give it too, by answering questions in your area of expertise. 2) Take the tour! 3) When you see good questions and answers, vote them up by clicking the gray triangles, because the credibility of the system is based on the reputation gained by users sharing their knowledge. Also, please remember to accept the answer, if any, that solves your problem, by clicking the checkmark sign! – Michael E2 May 18 '16 at 15:40
  • People here generally like users to post code as Mathematica code instead of images or TeX, so they can copy-paste it. It makes it convenient for them and more likely you will get someone to help you. You may find this this meta Q&A helpful – Michael E2 May 18 '16 at 15:40
  • Duplicates: http://mathematica.stackexchange.com/q/17176/5 and http://mathematica.stackexchange.com/q/19816/5 – rm -rf May 19 '16 at 18:13

1 Answers1

6

You can do it by using the MessageName operator (::). Here is an example.

foo

Alexey Popkov
  • 61,809
  • 7
  • 149
  • 368
m_goldberg
  • 107,779
  • 16
  • 103
  • 257
  • Thank you! What about the creation of document pages? Is it possible? – Oscar Charles May 21 '16 at 19:18
  • @OscarCharles. I believe that is possible with Wolfram Workbench. I have never use that development tool (not installed on my system), so I have no experience with writing Wolfram-like documentation pages. – m_goldberg May 21 '16 at 23:56