Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [cdt-dev] Need guidance/comments on package (re-)naming
Hi Martin,

I think it is great you are trying to separate it. To answer your original first question, no there are no conventions in CDT that I know of. Historically all the code is in one (or a few) big bundle and separated somewhat into internal and non-internal packages. This is true of JDT and Eclipse Platform too where we inherit a lot of CDT original design from. The current code is more split by feature than by programmers purpose.

participant is a good name for something that participates in the operation via extension point, e.g. some classes in Eclipse Platform (like IDocumentSetupParticipant) use that as part of their name. javadoc starts like this for IDocumentSetupParticipant

 * Participates in the setup of a text file buffer document.
 * <p>
 * This interface is the expected interface for extensions provided for the
 * <code>"org.eclipse.core.filebuffers.documentSetup"</code> extension point.


HTH,
Jonah

~~~
Jonah Graham
Kichwa Coders
www.kichwacoders.com


On Mon, 25 May 2020 at 16:11, 15 knots <fifteenknots505@xxxxxxxxx> wrote:
Hi Alexander,

Am Fr., 22. Mai 2020 um 21:10 Uhr schrieb Alexander Fedorov <alexander.fedorov@xxxxxxxxxx>:
Hi Martin,

I don't think the "ep" is the right segment for API, because "extension point" is just a technology
Good point.
But with 5 public classes for the consumer API vs. 16 classes for the contribute more implementations API I still want to keep them separated to not confuse people that implement a consumer.
That contribute more implementations API actually is for third-party compiler vendors so they can provide a plugin that understands the compiler specific command-line options and passes these to the indexer through the cmake indexer support plugin. That plugin would then participate in command-line analysis.
The main benefit to introduce that API was to reduce the number of incoming enhancement requests.

WDYT, would participant give a good name for the contribute more implementations API?
Or thirdparty?

Martin
_______________________________________________
cdt-dev mailing list
cdt-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/cdt-dev

Back to the top