build.xml refactoring got rid of API doc generation commands?

[Ville Rantanen]

build.xml does not have *docs targets anymore.

Are they to be added somewhere else?

[Kristian Ovaska]

I removed them because we are using SBT now to build core, and it might be better just to add more targets to build.sbt.

Which docs do you need? Javadoc or component docs?

[Ville Rantanen]

• bash doc
• python doc
• matlab doc
• R doc

[Ville Rantanen]

i'll implement these in the anduril doc --api command

[Kristian Ovaska]

bin/anduril is the best place for these.

But "anduril doc" is getting compicated. What would "anduril doc --api -b bundle -k key" mean, for example? If you have parameters that are valid only in a certain combination, you have in practice many sub-commands under "anduril doc".

What about:

• anduril build-doc --api (would also call sbt doc)
• anduril build-doc -b BUNDLE1 -b BUNDLE2 (to replace anduril doc --htm; --api is not allowed with thisl)
• anduril doc would then be the command-line browser to access, but not build, docs

This also has two sub-commands in build-doc, but the interface is still understandable.

[Ville Rantanen]

thats okay. i'll proceed

[Ville Rantanen]

how do we get the javadoc? sbt doc only generates scala runtime and table manipulation.

[Kristian Ovaska]

I added Java componentSkeleton (org.anduril.component) to 'sbt doc'. Other packages are only useful for core developer(s).

We can use Scaladoc also for Java classes.

[Ville Rantanen]

i guess we'll want the code developer docs to be available somewhere. at some point.. but that's for later.

[Ville Rantanen]

commands re-introduced