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

Update Docs #1012

Merged
merged 7 commits into from
Aug 9, 2022
Merged

Update Docs #1012

merged 7 commits into from
Aug 9, 2022

Conversation

HurricanKai
Copy link
Member

This also updates a bunch of the other docs.

@HurricanKai HurricanKai requested a review from a team as a code owner August 8, 2022 16:22
@Perksey
Copy link
Member

Perksey commented Aug 8, 2022

General advice as these seem pretty light (at least for now), if you went in any of the projects, could you use these docs to describe what all of the files do and how they all link together?

@HurricanKai
Copy link
Member Author

Added a bit more info & list of symbols. Anything I forgot to mention / that's unclear?

@Perksey
Copy link
Member

Perksey commented Aug 8, 2022

  • What is the Type ID? Where does it come from?
  • Where does the type store come from in SymbolVisitor? Is it new?
  • Could do with some example code, might be in the form of a link or an actual code snippet.
  • How do the type references work? Again links back to what are the type IDs.
  • Formatting documentation is awesome!
  • Visitor documentation is awesome!
  • Type resolution documentation doesn't actually indicate how the resolution logic works. I appreciate XML docs are used for individual type/function documentation, but the essence of the logic should still be documented I think.
  • Scraper documentation is a bit lacking as well, not really describing the essence of the logic.
    • e.g. "we invoke ClangSharp to get XML outputs, then we read that XML output (via the XmlVisitor) and convert it into the symbols described by the symbol layer, and that gets passed to ???"
  • Clang doesn't output XML, ClangSharp does though. This could be confusing as to where to look for further information.
  • Testing documentation is awesome!

Future:

  • Where do all of these symbols come from? Is there an example of them being created?
  • Where is the SymbolVisitor used in the other components? Is there an example you can link to?

@HurricanKai
Copy link
Member Author

I've addressed most of those concerns, thanks a lot for the detailed response!
I'm a little confused about the scraper docs, not sure what else I can really add, can you elaborate?
The hope would be that the scraper is very straight forward and only a small bridge between ClangSharp XML output and the symbol layer.

@HurricanKai
Copy link
Member Author

Merging this to unblock follow up work, but I'll follow up in another PR. Feel free to comment here

@HurricanKai HurricanKai merged commit 05085c5 into develop/3.0 Aug 9, 2022
@HurricanKai HurricanKai deleted the unify-symbols branch August 9, 2022 12:27
@Perksey
Copy link
Member

Perksey commented Aug 9, 2022

The hope would be that the scraper is very straight forward and only a small bridge between ClangSharp XML output and the symbol layer.

So say that! :D

@HurricanKai HurricanKai mentioned this pull request Aug 9, 2022
@HurricanKai
Copy link
Member Author

Addressed all of these in #1015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants