fix syntax in documentation comments

[Coeur]

Documentation comments (those starting with /**) are interpreted as Markdown by modern IDEs.

This PR is escaping the method names with underscores for proper display support.

[rockdaboot]

Thanks for your contribution.

The comments are made for gtkdoc, for automatic man page and HTML generation.
I am sorry to say that your PR breaks the HTML generation. You can try with

./configure --enable-gtk-doc --enable-gtk-doc-html
make
xdg-open docs/libpsl/html/index.html

What modern IDEs are you referring to? Are there possibly plugins for gtkdoc comment style available?

[Coeur]

Thank you, I'll investigate that gtkdoc. although for now I'm hitting:

zsh: no such file or directory: ./configure

[edit]
I think I solved that missing ./configure with:

brew install autoconf automake gtk-doc libtool
autoreconf -i

But now I'm hitting:

configure: error: You requested libidn2|libidn but libunistring is not installed.
➜  libpsl git:(rockdaboot) brew install libunistring
Warning: libunistring 1.1 is already installed and up-to-date.

---

The screenshot is from Xcode.

The DocC documentation compiler converts Markdown-based text into rich documentation for Swift and Objective-C frameworks

https://developer.apple.com/documentation/xcode/writing-documentation

That DocC format is the successor of the HeaderDoc format:
https://developer.apple.com/library/archive/documentation/DeveloperTools/Conceptual/HeaderDoc/tags/tags.html

[eli-schwartz]

Thank you, I'll investigate that gtkdoc. although for now I'm hitting:

zsh: no such file or directory: ./configure

The screenshot is from Xcode.

Are you using the instructions for building from a tarball, but downloading with git instead? Please follow the "building from git" instructions. :)

[eli-schwartz]

Also note that the autotools project files only produce Makefiles. You can build with meson instead, if you prefer, which has an option to actually generate xcode solutions.

[rockdaboot]

configure: error: You requested libidn2|libidn but libunistring is not installed.
➜ libpsl git:(rockdaboot) brew install libunistring
Warning: libunistring 1.1 is already installed and up-to-date.

Is there possibly a development package for libunistring? Or does the already installed package have all C header files?