Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide sources for protobuf-generated files in Build Directory #15

Closed
david-allison opened this issue Jan 19, 2021 · 5 comments
Closed
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@david-allison
Copy link
Member

In particular: RustBackend is auto-generated and documentation is vital in understanding the parameters.

We currently see a decompilation:

UInt32 findAndReplace(List<Long> var1, @Nullable String var2, @Nullable String var3, boolean var4, boolean var5, @Nullable String var6);

whereas we should see:

Backend.UInt32 findAndReplace(List<Long> nids, @Nullable String search, @Nullable String replacement, boolean regex, boolean matchCase, @Nullable String fieldName);

Note: The decompilation is seen when the library is obtained from files() - confirm if this is the same if obtained from Maven

@david-allison david-allison added the documentation Improvements or additions to documentation label Jan 19, 2021
@david-allison
Copy link
Member Author

Sources are included in the maven upload, but this does not (yet) include files in the build directory.

@david-allison david-allison changed the title Provide sources for rsdroid.aar Provide sources for protobuf-generated files in Build Directory Jan 22, 2021
@david-allison david-allison added the help wanted Extra attention is needed label Jan 24, 2021
@dae
Copy link
Contributor

dae commented Jun 19, 2022

This appears to have been fixed somewhere along the way? The backend methods show proper parameter names when hovering over them for me, at least when testing locally in the AnkiDroid project.

@mikehardy
Copy link
Member

is that still true when using the maven artifact and zero file references (and ...just thinking of how to really test the consumer experience in AnkiDroid) after invalidate caches + restart ?

@dae
Copy link
Contributor

dae commented Jun 19, 2022

Seems to be - AnkiDroid main branch, invalidate caches, and the argument names show up correctly on hover or when jumping to the declaration (which shows the decompiled class file):


    DeckID addOrUpdateDeckLegacy(@Nullable ByteString deck, boolean preserveUsnAndMtime);

    DeckTreeNode deckTree(long now, long topDeckId);

@mikehardy
Copy link
Member

sounds fantastic - thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants