Re: [External] : Re: external snippets

2022-03-24 Thread Jonathan Gibbons
Anna, Thanks for the update and for your efforts to support snippets within IDEA; I'm pleased you finally got it working. FWIW, there is a new Programmers Guide for snippets available with JDK 18. https://docs.oracle.com/en/java/javase/18/code-snippet/index.html -- Jon On 3/24/22 12:16 AM, A

Re: [External] : Re: external snippets

2022-03-24 Thread Anna Kozlova
Jonathan, thanks, it works with the "-sourcepath" option! Thanks again, Anna P.S. It was a typo in the path, I removed too much from my real absolute path, sorry about that On Thu, Mar 24, 2022 at 2:23 AM Jonathan Gibbons < jonathan.gibb...@oracle.com> wrote: > Anna, > > Maybe it was a typo bu

Re: [External] : Re: external snippets

2022-03-23 Thread Jonathan Gibbons
Anna, Maybe it was a typo but that command does not correspond to the file layout you described earlier. The command is missing the `main/java/` part. I don't know what `project_classpath` is in your case. If it is just the (output) classes directory, you might try adding a sourcepath option,

Re: [External] : Re: external snippets

2022-03-23 Thread Anna Kozlova
Hi Jonathan, how should IDE(A) pass the content of `snippet-files` to the javadoc, javac, etc? I hope I'll be able to fix that so users will be able to use the simple way of defining external snippets. Thanks Anna On Tue, Mar 22, 2022 at 3:31 PM Jonathan Gibbons < jonathan.gibb...@oracle.com> wro

Re: [External] : Re: external snippets

2022-03-23 Thread Anna Kozlova
Jonathan, IDEA runs javadoc tool as following `javadoc -d output -classpath project_classpath project_name/src/p/Main.java`. I can change this if I would understand what should be placed instead. I am sorry for not being able to understand myself Thanks, Anna On Wed, Mar 23, 2022 at 3:48 PM Jon

Re: [External] : Re: external snippets

2022-03-23 Thread Jonathan Gibbons
Anna, For javadoc itself, the intent is that you should not need to do anything else to have javadoc detect the `snippet-files` directory and to incorporate the content into the documentation.  You can verify that by manually running a javadoc command on the example files you have set up. Ho

Re: [External] : Re: external snippets

2022-03-22 Thread Anna Kozlova
Hi Jonathan, I have this structure: └── src └── main ├── java └── p └── Main.java |── snippet-files └── ShowOptional.java I think that IDE passes wrong parameters to the javadoc tool though I have no idea what should

Re: external snippets

2022-03-22 Thread Anna Kozlova
Hi Jonathan, thank you! Unfortunately (1) doesn't work for me, what I get with the last available jdk 18: Standard Doclet version 18+36-2087 Building tree for all the packages and classes... Generating project_name/output/p/Main.html... project_name/src/p/Main.java:8: error: File not found: ShowOp

Re: [External] : Re: external snippets

2022-03-22 Thread Jonathan Gibbons
Anna, That is the intended structure, but my experience has been that existing releases of the IDE incorrectly pass the contents of directories like `snippet-files` as source files when compiling the primary packages and classes, meaning `p/Main.java`. This applies to any analysis of the file

Re: [External] : Re: external snippets

2022-03-21 Thread Jonathan Gibbons
Anna, What is the layout for the files you are using? -- Jon On 3/21/22 10:31 AM, Anna Kozlova wrote: Hi Jonathan, thank you! Unfortunately (1) doesn't work for me, what I get with the last available jdk 18: Standard Doclet version 18+36-2087 Building tree for all the packages and classes.

Re: external snippets

2022-03-21 Thread Jonathan Gibbons
Anna, Separate from whether you use `class` or `file` to identify the snippet, there are two locations in which you can put the files. 1. In a subdirectory named `snippet-files` of the package that references the snippet. In this case, you do _not_ need a `--snippet-path` option. In your exa