Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Functions support on Global namespace very limited #38

Open
fjgarlin opened this issue Nov 11, 2021 · 7 comments
Open

Functions support on Global namespace very limited #38

fjgarlin opened this issue Nov 11, 2021 · 7 comments
Assignees
Labels
bug Something isn't working enhancement New feature or request
Milestone

Comments

@fjgarlin
Copy link
Contributor

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:
Screenshot 2021-11-11 at 17 32 55

@williamdes williamdes self-assigned this Nov 13, 2021
@williamdes williamdes added bug Something isn't working enhancement New feature or request labels Nov 13, 2021
@williamdes
Copy link
Member

Thanks, this will be improved

@williamdes williamdes added this to the v5.5.0 milestone Nov 13, 2021
@williamdes
Copy link
Member

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

@fjgarlin
Copy link
Contributor Author

fjgarlin commented Nov 15, 2021

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:

Screenshot 2021-11-15 at 09 37 51
vs
Screenshot 2021-11-15 at 09 38 14

  • 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

@williamdes
Copy link
Member

Hi @fjgarlin

Ability to search functions in the global search (always no results even if the functions are there)

This is now supported since 61abad3
Would you mind trying to let me know if this is okay on your side ?

You may run into #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

@fjgarlin
Copy link
Contributor Author

Thanks @williamdes - I can confirm that the search now works for functions:
Screenshot 2021-12-13 at 10 20 19

@williamdes
Copy link
Member

🎉 https://github.com/code-lts/doctum/releases/tag/v5.5.0

Some work is left but this will be a good starting point

@fjgarlin
Copy link
Contributor Author

I retested everything and can see the new additions, great work!

@williamdes williamdes modified the milestones: v5.5.0, v5.5.2 Feb 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Development

No branches or pull requests

2 participants