doctum
doctum copied to clipboard
Functions support on Global namespace very limited
When there are global functions in the code:
- These aren't linked to the source code, so there is a big list of functions coming from multiple files but it's impossible to know what comes from where
- Functions are not searchable via the search function.
You can reproduce generating documentation for any repository with procedural programming (at least part of the code).
See example here:

Thanks, this will be improved
These aren't linked to the source code, so there is a big list of functions coming from multiple files but it's impossible to know what comes from where
Should be fixed in latest dev phar, could you test it ? See: https://github.com/code-lts/doctum#installation
curl -O https://doctum.long-term.support/releases/5-dev/doctum.phar && chmod +x doctum.phar
Thanks for the fixes. I tested with the latest version and I can now see links to the source code, which is awesome.
I think that it still lacks (when comparing to output from class methods for example):
- Link to the detail of the function and its details as seen in the images below:
vs

- Ability to search functions in the global search (always no results even if the functions are there)
I'm testing with this repo: https://github.com/fjgarlin/phpdocs_generators/tree/main
Hi @fjgarlin
Ability to search functions in the global search (always no results even if the functions are there)
This is now supported since 61abad3bb63a8c2f2b6ecf25d650acc30dfa6ce6 Would you mind trying to let me know if this is okay on your side ?
You may run into https://github.com/code-lts/doctum/issues/39 but this is quite a rare edge case from what I know
Link to the detail of the function and its details as seen in the images below:
This is still to do, that would probably be for another release to not block the pile of things
Thanks @williamdes - I can confirm that the search now works for functions:

🎉 https://github.com/code-lts/doctum/releases/tag/v5.5.0
Some work is left but this will be a good starting point
I retested everything and can see the new additions, great work!