Indeed it is. Since the API is meant to expose internals of the compiler, its volatility is to be expected. However, I'd rather prefer to code something like:coderJeff wrote:...
But before make any decision: I hope that the './fbc-int/*.bi' files can be a way to share fbc internals with users & casual developers. I also hope that we are not required to support this exact API forever, as that could impede development. So I will say this, './fbc-int/*.bi' files will be accurate for the current version of fbc. Users can make use of these includes if they choose. And developers reserve the right to change at any time. Internals may change as needed for development. I think that's fair.
...
Code: Select all
dim as Fb.ArrayDescriptor _
arrayDescriptorFor( a() )
Regarding this, I'm of the opinion that documentation should be comprehensive (the FreeBasic Manual is arguably one of the best Open Source documentations out there; just look at the SDL2 docs -which is an industry standard- or the MSDN docs to see what I mean).coderJeff wrote:...
1) A while back you asked me about wiki location for the fbc.FBARRAY structure. I didn't really have a good answer or reason that it should only be in developer documentation, or that it should be added to user documentation. We don't really have any rules for what should be considered developer only content. Anyway, you already did the work, so it's OK with me that it is featured in user documentation. If ever find that it causes too much confusion for users, just move it back to developer documentation.
...
Everybody knows (or should know) its limits, so while these pages could be on the 'Developer Only' section, a link should be provided from the relevant, 'standard' pages (such as a link to the array descriptor docs right on the page that explains arrays), under an 'advanced' topic of sorts.