nim doc does not generate doc comments correctly #4913

Closed
enthus1ast opened this Issue Oct 19, 2016 · 1 comment

Projects

None yet

3 participants

@enthus1ast
Contributor

this nim code :

type
  # For firefox proxy settings
  FirefoxProxyType * = enum
      proxySystem = "0" ## system or no proxy
      proxyManual = "1" ## if the proxy settings are handled by the firefox user
      proxyAutoUrl = "2"  ## if firefox should fetch its config from the auto config url
      proxyAuto = "4"  ## automatically detect ??

  # All the proxy related information we can read from "prefs.js"
  FirefoxProxy * = tuple[ host: string, ## the http proxy
                          port: int,  ## the http proxy port
                          proxyType: FirefoxProxyType, ## enabled, disabled, autoconfig etc
                          remoteDns: bool, ## if the socks proxy wants us to pump dns through the proxy
                          socksHost: string, ## the host of the socks proxy
                          socksPort: int, ## the port of the socks proxy
                          ftpHost: string, ## the host of the ftp proxy
                          ftpPort: int, ## the port of the ftp proxy
                        ]

gets transformed to this html output (this is only the bug):

FirefoxProxy* = tuple[host: string, port: int, ## the http proxy port
                    proxyType: FirefoxProxyType, ## enabled, disabled, autoconfig etc
                    remoteDns: bool, ## if the socks proxy wants us to pump dns through the proxy
                    socksHost: string, ## the host of the socks proxy
                    socksPort: int, ## the port of the socks proxy
                    ftpHost: string, ## the host of the ftp proxy
                    ftpPort: int]
the http proxy   Source Edit

please note:

  1. host has no comment
  2. ftpPort has no comment
  3. "the http proxy" is not inside the code container
@Araq
Member
Araq commented Oct 20, 2016

Btw this tuple should really be an object.

@Araq Araq added a commit that closed this issue Oct 20, 2016
@Araq Araq fixes #4913 13b68a1
@Araq Araq closed this in 13b68a1 Oct 20, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment