Deploying to gh-pages from @ f07db73 🚀

pr-preview/4875/repository_structure.html

@@ -135,7 +135,7 @@
  <a href="#writing-documentation">Writing documentation</a>
  <ul>
  <li class="level2">
- <a href="#quick-guide-for-developing-the-doxygen-documentation">Quick guide for developing the Doxygen documentation</a>
+ <a href="#building-the-doxygen-documentation">Building the Doxygen documentation</a>
  </li>
  <li class="level2">
  <a href="#documentation-comments-style-guide">Documentation Comments Style Guide</a>
@@ -266,8 +266,8 @@ <h1><a class="anchor" id="writing-documentation"></a>
 <p>Documentation is generated from two main sources: README files distributed across the repository and comments within the code. The README files are tagged with documentation inclusion notes to indicate their integration into the P4 compiler documentation.</p>
 <p>Code comments should capture the main intent of the implementation and the "why", rather than the "how". The how can be read from the code, however, documenting the reasons why a certain implementation was chosen will help other contributors understand the design choices and enable them to reuse your code. Also important in the context of the compiler is to document the invariants for each pass (or groups of passes), since it is likely that other developers will need to insert additional passes, and they should understand the effects that the pass ordering has on the AST.</p>
 <p>Documentation in the markup documents is intended for higher level design documentation. The files will be automatically captured in the documentation in the order implied by their naming: XX_my_doc.md where XX is a number between 02-99. Currently, 00_revision_history.md contains the documentation revision history, and 01_overview.md is the overview of the compiler goals and architecture.</p>
-<h2><a class="anchor" id="quick-guide-for-developing-the-doxygen-documentation"></a>
-Quick guide for developing the Doxygen documentation</h2>
+<h2><a class="anchor" id="building-the-doxygen-documentation"></a>
+Building the Doxygen documentation</h2>
 <ul>
 <li>Doxygen is configured in <code>docs/doxygen/doxygen.cfg</code>.</li>
 <li>The main HTML page is configured in <code>docs/doxygen/Doxymain.md</code>:<ul>

pr-preview/4875/search/all_20.js

@@ -1,24 +1,13 @@
 var searchData=
 [
- ['warn_0',['Warn',['../namespace_p4.html#a3f204513d8ef11b57cae0f30becb863da56525ae64d370c0b448ac0d60710ef17',1,'P4']]],
- ['warn_1',['warn',['../class_p4_1_1_visitor.html#a12b8a4bdba2e0c0600ad87496a199d33',1,'P4::Visitor']]],
- ['warned_2',['warned',['../class_p4_1_1_remove_unused_declarations.html#a9f3cdb33606e9c641b1817f0512c521d',1,'P4::RemoveUnusedDeclarations']]],
- ['warning_3',['warning',['../namespace_p4.html#a14c553cb868e3303d6b29979570e1003',1,'P4::warning(const char *format, Args &&...args)'],['../namespace_p4.html#a2692fbe788231b09ac4bc47a62c3d7e5',1,'P4::warning(const int kind, const char *format, const T *node, Args &&...args)'],['../namespace_p4.html#a99e235b80c954a00fecb8b11bc2982c1',1,'P4::warning(const int kind, const char *format, const T &node, Args &&...args)'],['../namespace_p4.html#a38da086799a11f4ef176f9b02e7fad6c',1,'P4::warning(const int kind, const char *format, Args &&...args)']]],
- ['warning_5fenabled_4',['warning_enabled',['../class_p4_1_1_visitor.html#a855598301a9252de50b2a46715286605',1,'P4::Visitor::warning_enabled(int warning_kind) const'],['../class_p4_1_1_visitor.html#a883ecb795f506e021328e285c7c23264',1,'P4::Visitor::warning_enabled(const Visitor *visitor, int warning_kind)']]],
- ['warnings_5',['warnings',['../class_p4_1_1_do_constant_folding.html#a8fda82bf4aa6421c6ea6c76eb4c35957',1,'P4::DoConstantFolding']]],
- ['was_5fcalled_6',['was_called',['../class_p4_1_1_parser_structure_impl_1_1_parser_state_rewriter.html#a635c761ba888afa99fb1080e2d2a4b78',1,'P4::ParserStructureImpl::ParserStateRewriter']]],
- ['where_7',['where',['../class_p4_1_1_util_1_1_enumerator.html#aee029cc96a5ce334991e5c24092e7335',1,'P4::Util::Enumerator']]],
- ['widthbits_8',['widthBits',['../class_p4_1_1_type_map.html#a4747693124c9e53b8f28dea75410a37b',1,'P4::TypeMap']]],
- ['widthinbits_9',['widthInBits',['../class_p4_1_1_e_b_p_f_1_1_i_has_width.html#ad8707ea3c7d3db5e36abb21270f7860b',1,'P4::EBPF::IHasWidth::widthInBits()'],['../class_p4_1_1_e_b_p_f_1_1_e_b_p_f_bool_type.html#ab162b818fc401ea96d2a51adc164bf00',1,'P4::EBPF::EBPFBoolType::widthInBits()'],['../class_p4_1_1_e_b_p_f_1_1_e_b_p_f_stack_type.html#a7fb6c980fd3c0c57bfe9183a3f51d556',1,'P4::EBPF::EBPFStackType::widthInBits()'],['../class_p4_1_1_e_b_p_f_1_1_e_b_p_f_scalar_type.html#a1ad7f0fedf4fdbb0640969193223569c',1,'P4::EBPF::EBPFScalarType::widthInBits()'],['../class_p4_1_1_e_b_p_f_1_1_e_b_p_f_type_name.html#abecd503c7c57fb00b1889aa378803986',1,'P4::EBPF::EBPFTypeName::widthInBits()'],['../class_p4_1_1_e_b_p_f_1_1_e_b_p_f_struct_type.html#af67cbd24e9998806108cf9bc566e11d4',1,'P4::EBPF::EBPFStructType::widthInBits()'],['../class_p4_1_1_e_b_p_f_1_1_e_b_p_f_enum_type.html#a14ebf0c7563c72beda255192541eff85',1,'P4::EBPF::EBPFEnumType::widthInBits()'],['../class_p4_1_1_e_b_p_f_1_1_e_b_p_f_error_type.html#a361630f22feb0838cccf42803f505b18',1,'P4::EBPF::EBPFErrorType::widthInBits()'],['../class_p4_1_1_u_b_p_f_1_1_u_b_p_f_list_type.html#ae0d5b304aac9378a7e807f45aecd66d7',1,'P4::UBPF::UBPFListType::widthInBits()']]],
- ['with_20test_20frameworks_10',['Interacting with Test Frameworks',['../p4testgen.html#interacting-with-test-frameworks',1,'']]],
- ['with_20the_20tc_11',['Connecting the generated program with the TC',['../ebpf_backend.html#connecting-the-generated-program-with-the-tc',1,'']]],
- ['withfieldslocation_12',['WithFieldsLocation',['../class_p4_1_1_with_fields_location.html',1,'P4']]],
- ['wordlist_13',['Wordlist',['../class_p4_1_1_p4_tools_1_1_p4_smith_1_1_wordlist.html',1,'P4::P4Tools::P4Smith']]],
- ['writegraphtofile_14',['writeGraphToFile',['../class_p4_1_1graphs_1_1_graph__visitor.html#a97b4b4482a1e150a40fbd022864c1e43',1,'P4::graphs::Graph_visitor']]],
- ['writes_15',['writes',['../class_p4_1_1_compute_write_set.html#acb02d16c7cb96eb00cedc32d918ba59d',1,'P4::ComputeWriteSet::writes'],['../class_p4_1_1_definitions.html#a307f23c336cfd27a90ca195e134cc978',1,'P4::Definitions::writes()']]],
- ['writetargetpreamble_16',['writeTargetPreamble',['../class_p4_1_1_p4_tools_1_1_p4_smith_1_1_smith_target.html#a3c1d2d899c8a4b66a7323ebc7ae5c415',1,'P4::P4Tools::P4Smith::SmithTarget::writeTargetPreamble()'],['../class_p4_1_1_p4_tools_1_1_p4_smith_1_1_b_mv2_1_1_bmv2_psa_smith_target.html#a3aa672f778925f53cdea4efefdc0ea80',1,'P4::P4Tools::P4Smith::BMv2::Bmv2PsaSmithTarget::writeTargetPreamble()'],['../class_p4_1_1_p4_tools_1_1_p4_smith_1_1_b_mv2_1_1_bmv2_v1model_smith_target.html#a3ee08e999bacb8a1e2dbf85a35c1935a',1,'P4::P4Tools::P4Smith::BMv2::Bmv2V1modelSmithTarget::writeTargetPreamble()'],['../class_p4_1_1_p4_tools_1_1_p4_smith_1_1_generic_1_1_generic_core_smith_target.html#a808ace1800372cd0cdaad67eaa76267e',1,'P4::P4Tools::P4Smith::Generic::GenericCoreSmithTarget::writeTargetPreamble()'],['../class_p4_1_1_p4_tools_1_1_p4_smith_1_1_nic_1_1_dpdk_pna_smith_target.html#afcae61020f5b8b1b5590b99372fa0e35',1,'P4::P4Tools::P4Smith::Nic::DpdkPnaSmithTarget::writeTargetPreamble()'],['../class_p4_1_1_p4_tools_1_1_p4_smith_1_1_tofino_1_1_tofino_tna_smith_target.html#af376548fbffcc708da3d7c1120c2aa89',1,'P4::P4Tools::P4Smith::Tofino::TofinoTnaSmithTarget::writeTargetPreamble()']]],
- ['writetests_17',['writeTests',['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_testgen.html#add97d4003cea9fb947274e8f1842af0b',1,'P4::P4Tools::P4Testgen::Testgen::writeTests(const CompilerOptions &options, const TestgenOptions &testgenOptions)'],['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_testgen.html#a8de044b9a31381171626fff5e9916dcb',1,'P4::P4Tools::P4Testgen::Testgen::writeTests(std::string_view program, const CompilerOptions &options, const TestgenOptions &testgenOptions)']]],
- ['writetesttofile_18',['writeTestToFile',['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_test_framework.html#abc35f8e3e43c46a81b8111aee85b5577',1,'P4::P4Tools::P4Testgen::TestFramework::writeTestToFile()'],['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_bmv2_1_1_metadata.html#aaec4a4188e4ea9565a947596bd23e4b7',1,'P4::P4Tools::P4Testgen::Bmv2::Metadata::writeTestToFile()'],['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_bmv2_1_1_protobuf.html#ad97ce7d2ce069c12e81c249327d54546',1,'P4::P4Tools::P4Testgen::Bmv2::Protobuf::writeTestToFile()'],['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_bmv2_1_1_protobuf_ir.html#af360f02a1fe64ef8fd4e0dd3cb8c359d',1,'P4::P4Tools::P4Testgen::Bmv2::ProtobufIr::writeTestToFile()'],['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_bmv2_1_1_p_t_f.html#abdd6b79300d72233bccb1feb697665d2',1,'P4::P4Tools::P4Testgen::Bmv2::PTF::writeTestToFile()'],['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_bmv2_1_1_s_t_f.html#a1fee90d85fa1ed8472161ad8244f5604',1,'P4::P4Tools::P4Testgen::Bmv2::STF::writeTestToFile()'],['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_e_b_p_f_1_1_s_t_f.html#a0017e95c994f5a64fe94743c5fa8a4f3',1,'P4::P4Tools::P4Testgen::EBPF::STF::writeTestToFile()'],['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_pna_1_1_metadata.html#acc307d3dc37893fb4a71b536265b64f7',1,'P4::P4Tools::P4Testgen::Pna::Metadata::writeTestToFile()'],['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_pna_1_1_p_t_f.html#a6f92ec122475d724e615dd8ca1fe18ea',1,'P4::P4Tools::P4Testgen::Pna::PTF::writeTestToFile()']]],
- ['writetoindex_19',['writeToIndex',['../class_p4_1_1_p4_tools_1_1_p4_testgen_1_1_bmv2_1_1_index_map.html#a93ee8c4ae7b072f3c0ad350725f148c3',1,'P4::P4Tools::P4Testgen::Bmv2::IndexMap']]],
- ['writing_20documentation_20',['Writing documentation',['../repository_structure.html#writing-documentation',1,'']]]
+ ['xdp_20based_20design_0',['XDP-based design',['../ebpf_backend.html#xdp-based-design',1,'']]],
+ ['xdp2tc_20mode_1',['XDP2TC mode',['../ebpf_backend.html#xdp2tc-mode',1,'']]],
+ ['xdp_5fmodel_2',['Xdp_Model',['../struct_p4_1_1_e_b_p_f_1_1_xdp___model.html',1,'P4::EBPF']]],
+ ['xdpegressdeparserpsa_3',['XDPEgressDeparserPSA',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_egress_deparser_p_s_a.html',1,'P4::EBPF']]],
+ ['xdpegresspipeline_4',['XDPEgressPipeline',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_egress_pipeline.html',1,'P4::EBPF']]],
+ ['xdphelpprogram_5',['XDPHelpProgram',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_help_program.html',1,'P4::EBPF']]],
+ ['xdpingressdeparserpsa_6',['XDPIngressDeparserPSA',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_ingress_deparser_p_s_a.html',1,'P4::EBPF']]],
+ ['xdpingresspipeline_7',['XDPIngressPipeline',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_ingress_pipeline.html',1,'P4::EBPF']]],
+ ['xdptarget_8',['XdpTarget',['../class_p4_1_1_e_b_p_f_1_1_xdp_target.html',1,'P4::EBPF']]],
+ ['xor16_9',['xor16',['../namespace_p4_1_1_net_hash.html#aaffa89e4bd87fba4761506c9133df39f',1,'P4::NetHash']]]
 ];

pr-preview/4875/search/all_21.js

@@ -1,13 +1,4 @@
 var searchData=
 [
- ['xdp_20based_20design_0',['XDP-based design',['../ebpf_backend.html#xdp-based-design',1,'']]],
- ['xdp2tc_20mode_1',['XDP2TC mode',['../ebpf_backend.html#xdp2tc-mode',1,'']]],
- ['xdp_5fmodel_2',['Xdp_Model',['../struct_p4_1_1_e_b_p_f_1_1_xdp___model.html',1,'P4::EBPF']]],
- ['xdpegressdeparserpsa_3',['XDPEgressDeparserPSA',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_egress_deparser_p_s_a.html',1,'P4::EBPF']]],
- ['xdpegresspipeline_4',['XDPEgressPipeline',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_egress_pipeline.html',1,'P4::EBPF']]],
- ['xdphelpprogram_5',['XDPHelpProgram',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_help_program.html',1,'P4::EBPF']]],
- ['xdpingressdeparserpsa_6',['XDPIngressDeparserPSA',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_ingress_deparser_p_s_a.html',1,'P4::EBPF']]],
- ['xdpingresspipeline_7',['XDPIngressPipeline',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_ingress_pipeline.html',1,'P4::EBPF']]],
- ['xdptarget_8',['XdpTarget',['../class_p4_1_1_e_b_p_f_1_1_xdp_target.html',1,'P4::EBPF']]],
- ['xor16_9',['xor16',['../namespace_p4_1_1_net_hash.html#aaffa89e4bd87fba4761506c9133df39f',1,'P4::NetHash']]]
+ ['yylloc_0',['yylloc',['../class_p4_1_1_abstract_parser_driver.html#a24ade0995b31810ca08459b6966147e1',1,'P4::AbstractParserDriver']]]
 ];