Hi all,
because I know Robert Hook is out of office this week, so it's not easy for him to update the blog posted last week, I'd like to point out that Update 13 SDK is available for download from yesterday :-)
With regards,
Jan
Hi Jan,
Thank you for posting to notify others about the general availability of MicroStation CONNECT SDK Update 13, while I was out of office. To properly complete this thread, may you all take a moment to review the latest: MicroStation CONNECT Edition SDK Update 13 release announcement.
As always and again, thank you for your additional assistance in keeping everyone up to date and on the right path.
Thank you,Bob
Robert Hook said:may you all take a moment to review the lates
That summary is helpful. To realize there are new chm files is simple (and I like doc generated using DocFx ;-), to find out what was changed or added to API or examples is nearly impossible without such list ;-)
Bentley Accredited Developer: iTwin Platform - AssociateLabyrinth Technology | dev.notes() | cad.point
Robert Hook said:may you all take a moment to review the latest: MicroStation CONNECT Edition SDK Update 13 release announcement
Jan Šlegr said:That summary is helpful
I agree: very useful!
EC Services and EC Objects provide some useful introductory material, which in general has been absent from SDK help files. Good progress!
Unfortunately, there are a number of alerts like this: [Missing documentation for "T:Bentley.ECN.IECInstance"]
EC Objects in particular has some good information about EC Schemas. I wish that it had been available years ago...
ECObjects is the bedrock of interoperability. -- Casey Mullen, 2015
Regards, Jon Summers LA Solutions
Thank you for the mentaion/share of DocFx. I will certainly take a look at it, specifically its (build) differencing capabilities.
Hi Jon,
Thank you too for the announcement feedback and I will queue up the EC doc items you found for review and update.
Jon Summers said:Unfortunately, there are a number of alerts like this: [Missing documentation for "T:Bentley.ECN.IECInstance"]
Yes, I found them also. Because I assume the documentation is generated using DocFX (just because of the help look), I assume some links were broken during a conversion from code to web pages (DocFX functionality) or when the result was converted to chm (have no idea how exactly it was done and using what postprocessor ... I am quite curious ;-).
It's a standard DocFX feature that it allows (easier than Doxygen in my opinion) to merge documentation created from code and additional documentation, e.g. about assembly, namespaces or high-level concepts (nice example is Articles chapter in ECObjects). Probably this part was broken (or when looking at my projects, simply not finished yet ;-).
Jon Summers said:EC Objects in particular has some good information about EC Schemas. I wish that it had been available years ago...
Exactly, I think I had to invest hundreds (or thousands?) hours to study different limited sources, play with Class Editor and trying to create code snippets to understand how this ecosystem works.
Regards,
Robert Hook said:the mentaion/share of DocFx.
I used recently DocFX in my one project (because a customer requires it) and I was surprised. Great thing is that it's developed actively (in contrast with Sandvastle and Doxygen) and it's even planned to merge public GitHub and internal Microsoft branches together in V3 (because as far as I understand, "DocFX derivative" is the tool Microsoft uses to generate all their web documentation).
There are also some disadvantages, especially it's maybe too flexible and too modular, where Doxygen is more "it works on a mouse click" (and Doxygen supports more languages automatically without any extensions or additions).
Robert Hook said:specifically its (build) differencing capabilities.
It seems to be quite complex, but flexible, so it can be probably used for pretty wide range of projects.
My wish is whether the whole documentation can be merged into one file. Or maybe two: ECObjects (now 4 files!) and everything else (now 5 files!). It's so time consuming to find anything now :-(
Of course even better would be to post it on web (btw DocFX contains internal web server, so it's prepared for it), but I know Bentley are scared to provide anything free outside BDN closed environment (in contrast what all Bentley competitors do).
It's off-side question how it's possible that API documentation is available for BDN member only and as chm files only, it's also available publicly on (not Bentley) web.
HI Jan,
I do see reference that DoxFX is used specific for GIT in our: Get And Build GIT based ECFramework process.