What information do you want included in the documentation that is not currently there ?Whether correctly I understood you what you are asking about what I (like the user or developer) want to see in the documentation additionally?
Be realistic.At this case I haven't any wishes.
Not even a little funny.Be realistic.At this case I haven't any wishes.
The number one issue for me would be the lack of xml documentation included with the API's. It just boggles my mind that 10 years after creation this is still not implemented.
There should at a minimum be a short summary, a description of each parameter and what it does, and a description of each exception that could be thrown.
The number one issue for me would be the lack of xml documentation included with the API's. It just boggles my mind that 10 years after creation this is still not implemented.
There should at a minimum be a short summary, a description of each parameter and what it does, and a description of each exception that could be thrown.
The number one issue for me would be the lack of xml documentation included with the API's. It just boggles my mind that 10 years after creation this is still not implemented.Yeah, this. All those crazy bools that do...do what!?!?! Having the facts in front of me would save me going to the .NET chm file, then off to the ARX chm file because the .NET one had nothing.
There should at a minimum be a short summary, a description of each parameter and what it does, and a description of each exception that could be thrown.
< .. > On the base of first message of this theme I thought the Autodesk has the plans for editing documentation and therefore they want to get the wishes about it.
Why don't you try again :)Because I am forced to be a realist.
Be explicit.Where a wish stops being "realistic"? In my opinion the volume of work for adding XML comment to API is not less than the work for any my wish which was pointed by me. Then on the basis of what criteria the "reality" or "unreality" is defined? Also, I thought my wishes are explicit and are not bitching...
No bitching.
Be realistic.
Please send me an email listing the documentation gaps you care about most and I'll pass it on to the person managing the docs.
Code samples are also handy. It's all well and good to talk about how to use something but I'm sure I am not the only one who sees an actual example and says "oh, that's what they meant there". They are also handy for showing best practices.
Code samples are also handy. It's all well and good to talk about how to use something but I'm sure I am not the only one who sees an actual example and says "oh, that's what they meant there". They are also handy for showing best practices.
I'll have to disagree on that. Short, concise code samples showing an optional parameter, object, etc. don't necessarily follow best practices such as error handling. Perhaps a two-pronged approach: short examples local to the object at hand, plus several overall examples, referenced in multiple places, that also demonstrate overall coding techniques?
something along the lines of CodePath (maybe?): https://guides.codepath.com/android (https://guides.codepath.com/android)
Just to follow up on this... the docs do indeed need to be fixed. You can rely on Editor.Command() completing commands for you rather than cancelling them: so you should only need a while loop if you need finer-grained control over the command tokens.
Kean
For Kean, or the assigned tech :
Has this ever been done.
If so, Where ?
Advice regarding the use of Transactions is contradictory.No matter which one used they end up calling the same methods but for many calls it might matter which one used for AddNewlyCreatedDBObject.
Refer the ..\ObjectARX 2016\Samples\dotNet\ files
Typically the Tables are instantiated using the GetObject method of the TransactionManager.
The AddNewlyCreatedDBObject method variously uses the Transaction and the TransactionManager
Advice and examples elsewhere use the methods of the Transaction, which I understand is correct.
Why are they different ?
Determining or making Table Records.Fundamental information about the API would help I think.
Invariably there is no advice to make allowance for Records that have been erased.
Typically the advice is to simply check if the Table Has the record and either return the Id of Add a new Record and return it's Id.
Can we please have a definitive description of the full technical meaning of the noDocument parameter for the Database constructor.
purpose,
ramifications
side effects
traps
added:
Are there any special considerations regarding Transactions or DocumentLocking associated with either option ??
bool noDocument = false
Boolean specifying whether or not to associate this database to the current document. When noDocument = true, then the database is standalone, which means the database does not use the documents undo controller, locking, and other services.