Mirror of forum.nim-lang.org

801 :: Extract double-hash documentation comments?

• jboy (orginal) [2015-01-27T14:27:41+01:00] view original

  Hi, I see that double-hash comments are interpreted as documentation -- the equivalent of Python docstrings.

  I would like my code to extract these documentation comments and use them for introspection documentation.

  The tutorial mentions that "documentation comments are tokens ... they belong to the syntax tree", and when I use dumpTree to print the AST, I can in fact see my nnkCommentStmt node in there.

  However, I can't work out how to extract the comment text in my code. I can't access any internal structure in the nnkCommentStmt node, and I can't find any functions (outside the Nim compiler code) that handle nnkCommentStmt nodes.

  Is it possible for non-compiler (non-docgen) code to extract the text of double-hash documentation comments?

  Thanks.

---

• dom96 (orginal) [2015-01-28T02:05:12+01:00] view original

  Indeed. The docs need to be improved because there are many node kinds for which you simply have no way of knowing how you should access the data they hold. I have no idea how to access the nnkCommentStmt's data unfortunately. I would say you should raise an issue for this.

---

• jboy (orginal) [2015-01-28T07:04:58+01:00] view original

  @dom96: OK, thanks, done.

  I've also been working on another approach, which I'll post about shortly.

---

• jboy (orginal) [2015-01-28T13:52:49+01:00] view original

  OK, I've posted about my other approach in this new thread: a new module docstrings.

---