Skip to content
This repository has been archived by the owner on Jan 8, 2020. It is now read-only.

Add a little more detail to "components" #17

Open
matozoid opened this issue Dec 10, 2017 · 5 comments
Open

Add a little more detail to "components" #17

matozoid opened this issue Dec 10, 2017 · 5 comments

Comments

@matozoid
Copy link
Contributor

It would be good to mention the following "components" or "features" with a one or two line description:

  • pretty printing
  • meta model
  • CST
  • lexical preservation
  • mutable AST
  • visitors
  • tokens attached to nodes
  • comment assignment algorithm
  • Javadoc parser/printer
  • Source root
@ftomassetti
Copy link
Member

True. Some of them are user facing features, while others (CST, meta model) are more implementation information relevant to contributors or very advanced users

@matozoid
Copy link
Contributor Author

The CST certainly pretty prints well, though.

@ftomassetti
Copy link
Member

Should we have a specific page named components? Should we list those in the homepage?

@matozoid
Copy link
Contributor Author

I've used "features" instead of "components" in our secret document now, that seems to cover the topic better. I propose something like "Symbol Solver - (description of what it does) - (description of what to expect when using it)"

@matozoid
Copy link
Contributor Author

Oh, yeah, we can make a separate page or not. You're in charge of the site :-)

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

No branches or pull requests

2 participants