chore: Move introductory text for Javadoc examples into the <pre> block.

[jinseopkim0]

b/413078744

[gemini-code-assist]

Code Review

This pull request moves descriptive Javadoc text from standard paragraphs into code blocks as comments. The reviewer recommends reverting these changes to maintain idiomatic Javadoc formatting and semantic correctness, providing specific suggestions to keep the text as preceding paragraphs for better readability in generated documentation.

[gemini-code-assist]

While moving the introductory text into the

 block makes it more convenient for copy-pasting, it is generally better for Javadoc readability to have descriptive text as a paragraph before the code example. This approach makes the generated documentation cleaner and more semantically correct. The previous implementation was more idiomatic for Javadoc.

  

    

      

        Suggested change
      
    
    

      

          

            

            
 * <pre>
          
          

            

            
 * // In order to use the emulator for a JUnit 4 test you might do something like this:
          
          

            

            
 * <p>In order to use the emulator for a JUnit 4 test you might do something like this:</p>
          
          

            

            
 *
          
          

            

            
 * <pre>
          
      
    
    

  

[gemini-code-assist]

For better Javadoc readability and semantic correctness, introductory text for code examples should be in a paragraph preceding the

 block. Placing it as a comment inside the block, as done here, can make the generated documentation less clean. The original approach is generally preferred.

  

    

      

        Suggested change
      
    
    

      

          

            

            
 * <pre>
          
          

            

            
 * // Example for connecting to a datastore:
          
          

            

            
 * <p>Example for connecting to a datastore:</p>
          
          

            

            
 *
          
          

            

            
 * <pre>