Yard doc corrections

[void-in]

The YARD doc comments in the modules have lots of issues that needs to be sorted out. This is the initial pass through. Primarily two types of comments are there:

# @param [Type] name desc

and

# @param name [Type] desc

I opted for the first one since that is the recommended one. If everyone agrees, then will change and make rest of the comments compatible as well.

[jlee-r7]

There's a lot of potential for bikeshedding here, but I'm going to weigh in with my favorite color: I prefer the param name in front of the type, e.g. @param foo [String] used for thing

[jlee-r7]

This is incorrect. The method returns a Pathname object.

[void-in]

@jlee-r7 Thanks a lot for your input. This is the first time I am working with YARD docs so please bear with me. Will get it done.

[jlee-r7]

Awesome, thank you! Documentation isn't an area lots of people are interested in, so I really appreciate any help we can get there.

[OJ]

Big plus one from me. Much love to anyone who puts time and effort into the documentation. Kudos for the effort.

[void-in]

@jlee-r7 The auxiliary folder is completed now. I hope the large number of files won't be an issue.

Some other observations:
modules/axiliary/scanner/modbusclient.rb should be modules/axiliary/scanner/modbus_client.rb
modules/axiliary/scanner/modbusdetect.rb should be modules/axiliary/scanner/modbus_detect.rb
modules/axiliary/scanner/snmp_enumshares.rb should be modules/axiliary/scanner/snmp_enum_shares.rb
modules/axiliary/scanner/snmp_enumusers.rb should be modules/axiliary/scanner/snmp_enum_users.rb
modules/axiliary/scanner/ssh/ssh_enumusers.rb should be modules/axiliary/scanner/ssh/ssh_enum_users.rb

modules/axiliary/scanner/udp_scanner_template should be moved to documentation since it is just a template file the purpose of which I believe is to provide a boiler template to be implemented by UDP scanner modules.

auxiliary/vsploit/exploit/ is empty. It should be removed.

[jvazquez-r7]

Thanks @void-in eyeballed, fixed a couple of things and landed: 6c36a82

Super thanks of the effort!

Also, moved some cleanup to #5002 to avoid conflicts on that PR :)

• jvazquez-r7@11d372b
• jvazquez-r7@75c6341