Bug 201439 - "Generate Architecture Description" generates an unwanted default answer for arch-where in the html output
"Generate Architecture Description" generates an unwanted default answer for ...
Status: RESOLVED WORKSFORME
Product: apisupport
Classification: Unclassified
Component: API docs
7.0.1
All All
: P4 (vote)
: TBD
Assigned To: Jaroslav Tulach
issues@apisupport
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2011-08-30 14:15 UTC by bdschubert
Modified: 2011-11-15 17:37 UTC (History)
1 user (show)

See Also:
Issue Type: DEFECT
:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description bdschubert 2011-08-30 14:15:58 UTC
My output for the arch-where includes the a reference to the NetBeans repositories even though I deleted the tag "defaultanswer generate='here'".

Here is the source for the arch-where answer:

 <answer id="arch-where">
     <p>
     Sources are in the SVN repository for the <a href="http://kenai.com/projects/emxsys/sources">
                Emxsys project on Project Kenai</a>: emx_gis-shapefiles.
     </p>
 </answer>

And here is the output:

Question (arch-where): Where one can find sources for your module?
Answer:
Sources are in the SVN repository for the Emxsys project on Project Kenai: emx_gis-shapefiles.
The default answer to this question is:
The sources for the module are in the NetBeans Mercurial repositories. 


----
Product Version = NetBeans IDE 7.0.1 (Build 201107282000)
Operating System = Windows Vista version 6.0 running on x86
Java; VM; Vendor = 1.6.0_24
Runtime = Java HotSpot(TM) Client VM 19.1-b02
Comment 1 Jaroslav Tulach 2011-11-04 12:36:31 UTC
Well, that is the reason we generate default answer and you can change it. Btw. what do you use arch.xml for? It is not easy to use it from plain harness, isn't it?
Comment 2 bdschubert 2011-11-04 14:05:04 UTC
(In reply to comment #1)
> Well, that is the reason we generate default answer and you can change it.

I expected that my answer would supplant the default answer. I did not expect the default answer to be appended to my answer.

> Btw. what do you use arch.xml for? It is not easy to use it from plain harness,
> isn't it?

Yes, I concur, it's not easy to use.  I'm attempting to use the arch.xml to document my modules in the same vein that NetBean modules are documented.  However, I'm looking for a more interactive process. I'm working on a plugin that manifests the questions/answers and an editor for the currently selected module. My hope is that (1), I can keep the arch.xml up-to-date as my modules evolve and mature; and (2), that I can easily view the architecture docs for the modules I'm using to ensure that I'm using them correctly.
Comment 3 bdschubert 2011-11-07 17:37:14 UTC
(In reply to comment #1)
> Well, that is the reason we generate default answer and you can change it.
I just learned that I can specify <defaultanswer generate='none'/> to defeat the default text. :-)  I found this out when I tried a bogus defaultanswer entry --  the build script's error message provided the valid options.

Perhaps this 'none' option should be added to the arch-where question's hint text so others don't make the same mistake I made (which was deleting the complete <defaultanswer/> entry).
Comment 4 Jesse Glick 2011-11-15 17:27:17 UTC
(In reply to comment #3)
> this 'none' option should be added to the arch-where question's hint text

It does already say:

"or just use tag defaultanswer generate='here'"
Comment 5 bdschubert 2011-11-15 17:37:50 UTC
(In reply to comment #4)
> It does already say: "or just use tag defaultanswer generate='here'"

Indeed. I'm just sayin' that that wasn't enough to prevent me from making the mistake of deleting that line versus using the 'none' option. I certainly won't have this issue in the future, but maybe others will -- or not, maybe it was just me. :-/   Anyway, its really a minor point, and I'm happy that it "works for me".


By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo