K
K
Karl Meinhoff2016-10-14 19:31:01
PHP
Karl Meinhoff, 2016-10-14 19:31:01

Why doesn't phpDocumentor pick up documentation in a file?

I wrote here the documentation for my bike, I decided to collect it. I collect and receive this magic:

Parsing /home/kkremen/PhpstormProjects/intranet-core/core/module/common-module.php
  No summary for method __construct()
  No summary for method __destruct()
  No summary for method newConfigReader()
  No summary for method newConfigWriter()
  No summary for method openDBTable()
  No summary for method openResource()
  No summary for method loadView()
  No summary for method newSession()
  No summary for method newCookieReader()

I checked this fucking file three hundred times - everything is in order, the comments are worth it - but the documentor still spits. Has anyone come across, knows what he needs?
UPD: pastebin.com/zU2hwCWy - link to the file itself

Answer the question

In order to leave comments, you need to log in

1 answer(s)
A
Alexey Nemiro, 2016-10-14
@KarleKremen

/**
 * @see CommonModule::onLoad()
 * CommonModule constructor. 
* You can not change the constructor directly, but you can use onLoad function instead.
 */
final function __construct()

Specifying @see before the description ( summary ) is wrong.
https://www.phpdoc.org/docs/latest/guides/docblock... You need to change the order, summary
should come first , then description can go , and only then tags ( @see - refers to tags ):
/**
 * CommonModule constructor. 
 * You can not change the constructor directly, but you can use onLoad function instead.
 *
 * @see CommonModule::onLoad()
 */
final function __construct()

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question