## Advanced description from docstring { #advanced-description-from-docstring }

You can limit the lines used from the docstring of a *path operation function* for OpenAPI.

Adding an `\f` (an escaped "form feed" character) causes **FastAPI** to truncate the output used for OpenAPI at this point.

It won't show up in the documentation, but other tools (such as Sphinx) will be able to use the rest.

   * we've chosen to instead use a signature that benefits existing users -- and is still safe.
   *
   * For convertAll, I haven't looked as closely at *how* much existing users benefit, so we should
   * keep an eye out for problems that new users encounter. Note also that convertAll could support

    return new Builder();
  }

  /**
   * A builder for simple, fast escapers.
   *
   * <p>Typically an escaper needs to deal with the escaping of high valued characters or code
   * points. In these cases it is necessary to extend either {@link ArrayBasedCharEscaper} or {@link
   * ArrayBasedUnicodeEscaper} to provide the desired behavior. However this builder is suitable for

    // that simply loops through the subscribers and dispatches the event to each would actually
    // probably provide a stronger order guarantee, though that order would obviously be different
    // in some cases.

    /** Global event queue. */
    private final ConcurrentLinkedQueue<EventWithSubscriber> queue = new ConcurrentLinkedQueue<>();

    @Override
    void dispatch(Object event, Iterator<Subscriber> subscribers) {

   * execute. If execution has already begun, the listener is executed immediately.
   *
   * <p>When selecting an executor, note that {@code directExecutor} is dangerous in some cases. See
   * the discussion in the {@link ListenableFuture#addListener ListenableFuture.addListener}
   * documentation.
   */
  public void add(Runnable runnable, Executor executor) {

        assertNotNull(filter);
    }

    // Test OPTIONS constant
    public void test_optionsConstant() {
        assertEquals("OPTIONS", CorsFilter.OPTIONS);
    }

    // Helper classes for testing

    private static class TestCorsHandlerFactory extends CorsHandlerFactory {
        private boolean getCalled = false;
        private String lastOrigin = null;
        private CorsHandler handler = null;

        annotations = new ArrayList<>();
        for (Annotation a : classOrMethod.getDeclaredAnnotations()) {
          /*
           * We avoid reflecting on NullMarked because its @Target(..., MODULE) causes problems
           * under JDK 8.
           */
          if (!(a instanceof NullMarked)
              && a.annotationType().isAnnotationPresent(TesterAnnotation.class)) {
            annotations.add(a);

    }

    // Test initializeProbes
    public void test_initializeProbes() {
        try {
            SuggestCreator.initializeProbes();
            // If no exception thrown, test passes
            assertTrue(true);
        } catch (Exception e) {
            fail("initializeProbes should not throw exception: " + e.getMessage());
        }
    }

    // Test process with properties path

        Secured secured = SecuredInterfaceImpl.class.getAnnotation(Secured.class);
        assertNull(secured); // Interface annotations are not inherited by implementing classes
    }

    // Test annotation array immutability
    public void test_annotationValueImmutability() {
        Secured secured = MultipleRolesClass.class.getAnnotation(Secured.class);

     * characters to lowercase.
     */
    open fun canonicalize(s: String): String = s
  }

  /** Tests integration between HttpUrl and the host platform's built-in URL classes, if any. */
  open class Platform {
    open fun test(
      codePoint: Int,
      codePointString: String,
      encoding: Encoding,
      component: Component,
    ) {
    }
  }