Red Hat Bugzilla – Bug 798671
Fix KnowledgeAgentConfiguration API JavaDoc
Last modified: 2015-06-01 21:36:50 EDT
KnowledgeAgentConfiguration API documentation states "drools.agent.newInstance = <true|false> // currently this is hard coded to true" but this is not true. You can use 'false' for incremental rebuilding of KnowledgeBase and it works. This needs to be corrected. Also other KnowledgeAgentConfiguration properties should be explained. Generally whole API could be better documented. Description of some methods is missing.
Partially fixed: I've fixed the drools.agent.newInstance issue on master, 5.4 and 5.3: https://github.com/droolsjbpm/droolsjbpm-knowledge/commit/ea912e101556f54d23ccd33520b7b2a65e146c63 Still open: "other KnowledgeAgentConfiguration properties should be explained." To me, it's unclear what drools.agent.scanDirectories actually does (if it does anything useful at all).
I've extracted the second part "other KnowledgeAgentConfiguration properties should be explained." into a separate issue: https://issues.jboss.org/browse/JBRULES-3454
Thanks for your fix of the misleading information described above, but I am afraid that it is not still enough. The most of the descriptions of the properties is missing. I think that the fact that the property can be true or false is not satisfactory for users. drools.agent.scanResources - missing explanation drools.agent.scanDirectories - just mentioned in documentation (4.2.6) drools.agent.newInstance - explained just in documentation (section 2.3.2.2) drools.agent.monitorChangeSetEvents - missing explanation drools.agent.useKBaseClassLoaderForCompiling - explained just in documentation (2.3.2.1.2), javadoc is missing So, some of the properties are not described, explanation of others is a bit scattered among docs. I think that at least missing explanations should be fixed. If the properties would be described together in one place (javadoc), it would be excellent.
Assigning to Edson, as he 'll know what those properties do. I took one of his knowledge agent issues earlier, so I hope he's cool with it ;)
Done.
Edson Tirelli <ed.tirelli@gmail.com> updated the status of jira JBRULES-3454 to Resolved
Edson Tirelli <ed.tirelli@gmail.com> updated the status of jira JBRULES-3454 to Closed
Hello Edson, thanks for your fix of scan directory option in Java code. https://github.com/droolsjbpm/drools/commit/4e6267cbde29148ac8872f9006e164e5f4735cfc Unfortunately I have to set this bug to ASSIGNED, because this bug is about missing explanations of knowledge agent features and properties in documentation, which was not fixed yet.
Hi Jiri, I think you missed the commit on the droolsjbpm-knowledge repository that is where the public javadocs are committed: https://github.com/droolsjbpm/droolsjbpm-knowledge/commit/c5bb2acbe57d8437f4847aecce8871f7cf624d6c While investigating the use of each property I found that minor mistake that I fixed in drools-core, so I associated to the same ticket, but the bulk of the content in this ticket is in the commit above. I am setting the status back to MODIFIED. Please let me know if it is not what was requested.
Hi Edson, you are right, I missed your commit to droolsjbpm-knowledge repository. I think it is perfectly ok, that you have added Javadoc and fixed a small mistake too.
THe fix made it into the code. VERIFIED.