Welcome,
Guest
. Please
login
or
register
.
Did you miss your
activation email?
September 07, 2010, 10:51:41 AM
2809
Posts in
829
Topics by
1931
Members
Latest Member:
warepublic
Home
Help
Search
Calendar
Login
Register
XMetaL Community Forums
|
General
|
General XMetaL Discussion
|
API doc request
« previous
next »
Pages:
1
Print
Author
Topic: API doc request (Read 316 times)
dcramer
Member
Posts: 118
API doc request
«
on:
May 21, 2010, 09:58:00 AM »
Please consider adding version information to the methods, properties, and events in the API docs. For example, when new methods are introduced (e.g. in 6.0) then the documentation for those methods should say "Since 6.0" or something. That way you know if you are using a method not supported in older versions and you can also easily find the cool new stuff in the api docs without digging through the release notes.
Thanks,
David
Logged
David Cramer
Technical Writer
Motive, an Alcatel-Lucent Company
Derek Read
Program Manager (XMetaL)
Administrator
Member
Posts: 831
Re: API doc request
«
Reply #1 on:
May 21, 2010, 05:59:56 PM »
I agree, this would be useful for some people. I'll ask our documentation people to consider it.
Logged
Derek Read, Program Manager (XMetaL)
LeeHart
Member
Posts: 22
Re: API doc request
«
Reply #2 on:
May 25, 2010, 11:20:38 AM »
I agree it would be useful and it's something we do in our docs. What I have done is to extract the .idl from the typelib in XMetaL*.exe (using the OleView.exe to open the .exe and save the .idl) and check them in. I can easily diff the different versions to see what is different. I believe that some diff tools can also create an annotated version that shows which lines were added or removed from the base; it's no longer useful as an .idl but it's useful for version differences (we are primarily only concerned about 2 different versions of XMetaL.)
Lee
Logged
Pages:
1
Print
XMetaL Community Forums
|
General
|
General XMetaL Discussion
|
API doc request
« previous
next »
Link to Calendar
Jump to:
Please select a destination:
-----------------------------
General
-----------------------------
=> Forum Information
=> General XMetaL Discussion
=> DITA and XMetaL Discussion
=> XMetaL Tips and Tricks
=> XMetaL Announcements and Events
Hosted by JustSystems Canada, Inc.,
na.justsystems.com.
Powered by SMF 1.1.5
|
SMF © 2006-2008, Simple Machines LLC
Loading...