`nodoc` deprecation

[LynxLynxx]

In 8.3.4 release nodoc was depricated but in README it's still exists as an option.

And when in dartdoc_options.yaml I declare this nodoc I'm getting an error that this flag will be deprecated.

My issue is that I need a way to exclude/nodoc files that are generated by build_runner.

I didn't find any documentation on how to exclude specific files (or better, a pattern like: generated/*.

I know there is an option to exclude classes, but there are a lot of classes that are generated in my project, so it's not really an option.

[srawlins]

Thanks for filing an issue. Removing the nodoc option is part of an effort to simplify the code base and reduce the maintenance cost.

If the files generated by build_runner should not be part of the package's public API, can they be generated into lib/src?

[sigurdm]

What @srawlins says, but also see #2236 (comment)

I believe you can make a library-level dartdoc with a @nodoc directive, that should keep the entire library undocumented.

Like so:

/// @nodoc
library;

[sigurdm]

We prefer relying on directives going into the library itself - that's why we deprecated the options from the dartdoc_options file.
Closing this as wontfix

[LynxLynxx]

Can you at least update README file with note about this? That the only way to hide files from documentation is to place them in /src directory?

[sigurdm]

Sure, we need to update the readme. (cc @szakarias)

But it is not the only way to hide the file. You can annotate it with a @nodoc annotation comment on the library annotation