Media Suite Install Guide for Release 5.7.18

Total Page：16

File Type：pdf, Size：1020Kb

Media Suite Install Guide for Release 5.7.18

Media Suite Installation Guide Release 5.7.18 Americas headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883 Notices Trademark Acknowledgements Cisco, Cisco Systems, the Cisco logo, and the Cisco Systems logo are registered trademarks or trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and certain other countries. All other trademarks shown are trademarks of their respective owners. Publication Disclaimer Cisco Systems, Inc. assumes no responsibility for errors or omissions that may appear in this publication. We reserve the right to change this publication at any time without notice. This document is not to be construed as conferring by implication, estoppel, or otherwise any license or right under any copyright or patent, whether or not the use of any information in this document employs an invention claimed in any existing or later issued patent. Copyright Copyright © 2017 Cisco Systems, Inc. All rights reserved. Information in this publication is subject to change without notice. No part of this publication may be reproduced or transmitted in any form, by photocopy, microfilm, xerography, or any other means, or incorporated into any information retrieval system, electronic or mechanical, for any purpose, without the express permission of Cisco Systems, Inc. OPENCASE VERSION 4.1 Table of Contents Chapter 1 Overview 1 Media Suite Overview. 1 Installer Changes . 1 Guide Audience . 2 Guide Conventions . 2 Chapter 2 Deployment Considerations 3 System Requirements. 3 mod_cluster . .4 Network Throughput . .4 Application Servers . .4 Load Balancers . .4 Database Servers . .6 Encoding/Encrypting Servers . .6 Inter-Server Communication . .6 Media Suite Components . 7 OpenAM . .7 Administration System . .8 Capture Manager . .8 Content Management System . .8 EPG Manager . .8 Merchandiser . .9 Producer . .9 Workflow System . .10 Peripheral Components . 10 RemoteFS . .10 Report Manager . .10 iii Installer Automation API . 11 Virtualization . 11 Recommended Deployment . 11 Notes on the Recommended Deployment . .13 Chapter 3 Preparing a Database/Schema for Media Suite 15 Supported Database. 15 Details to Investigate . .15 Preparing Oracle for Media Suite . 16 Use UTC . .16 Configuring Oracle for Extended Character Sets . .16 Configuring Database Permissions. 17 Chapter 4 Preparing Linux for Media Suite 19 Software Requirements . 19 Deprecated Requirements . .20 Preparing your Linux Environment . 20 Synchronizing with an NTP Server . .20 Adding a User . .21 Setting ulimit Values . .21 Network Structure . 21 Load Balancer Health Checks . .21 Planning Ahead on Security . .22 Media Suite Component Dependencies . .23 Next Steps . 27 iv OPENCASE VERSION 4.1 Chapter 5 Installing Media Suite on Linux 29 Installation Overview. 29 Understanding the Install Manager Node . .30 Deployment Recommendations . .30 Generating SSL Certificates for Full HTTPS. 30 Starting a Media Suite Install . 31 Launching Installer Manager. 31 Selecting Packages . .32 Validating Dependencies . .34 Selecting Packages . .34 Viewing Selected Packages . .34 Configuring Endpoints . .34 Configuring the Database/Schema . .36 Mapping Datasources . .37 Configuring Module-Specific Settings . .37 Custom File Deployment . .41 Custom Log4j Appenders . .42 Understanding Passwords and Security . .43 Setting or Updating Passwords . .44 Updating the Database/Schema . .45 Deploying RPM Packages onto Nodes. 46 Installing/Upgrading Merchandiser . .47 Startup and Shutdown Considerations . 48 Node Failover . 49 Securing OAuth Data Transmission.

138

Copy Link

Recommended publications

Rich Internet Applications
Rich Internet Applications (RIAs) A Comparison Between Adobe Flex, JavaFX and Microsoft Silverlight Master of Science Thesis in the Programme Software Engineering and Technology CARL-DAVID GRANBÄCK Department of Computer Science and Engineering CHALMERS UNIVERSITY OF TECHNOLOGY UNIVERSITY OF GOTHENBURG Göteborg, Sweden, October 2009 The Author grants to Chalmers University of Technology and University of Gothenburg the non-exclusive right to publish the Work electronically and in a non-commercial purpose make it accessible on the Internet. The Author warrants that he/she is the author to the Work, and warrants that the Work does not contain text, pictures or other material that violates copyright law. The Author shall, when transferring the rights of the Work to a third party (for example a publisher or a company), acknowledge the third party about this agreement. If the Author has signed a copyright agreement with a third party regarding the Work, the Author warrants hereby that he/she has obtained any necessary permission from this third party to let Chalmers University of Technology and University of Gothenburg store the Work electronically and make it accessible on the Internet. Rich Internet Applications (RIAs) A Comparison Between Adobe Flex, JavaFX and Microsoft Silverlight CARL-DAVID GRANBÄCK © CARL-DAVID GRANBÄCK, October 2009. Examiner: BJÖRN VON SYDOW Department of Computer Science and Engineering Chalmers University of Technology SE-412 96 Göteborg Sweden Telephone + 46 (0)31-772 1000 Department of Computer Science and Engineering Göteborg, Sweden, October 2009 Abstract This Master's thesis report describes and compares the three Rich Internet Application !RIA" frameworks Adobe Flex, JavaFX and Microsoft Silverlight.
[Show full text]
Javafx in Action by Simon Morris
Covers JavaFX v1.2 IN ACTION Simon Morris SAMPLE CHAPTER MANNING JavaFX in Action by Simon Morris Chapter 1 Copyright 2010 Manning Publications brief contents 1 ■ Welcome to the future: introducing JavaFX 1 2 ■ JavaFX Script data and variables 15 3 ■ JavaFX Scriptcode and structure 46 4 ■ Swing by numbers 79 5 ■ Behind the scene graph 106 6 ■ Moving pictures 132 7 ■ Controls,charts, and storage 165 8 ■ Web services with style 202 9 ■ From app to applet 230 10 ■ Clever graphics and smart phones 270 11 ■ Best of both worlds: using JavaFX from Java 300 appendix A ■ Getting started 315 appendix B ■ JavaFX Script: a quick reference 323 appendix C ■ Not familiar with Java? 343 appendix D ■ JavaFX and the Java platform 350 vii Welcome to the future: introducing JavaFX This chapter covers ■ Reviewing the history of the internet-based application ■ Asking what promise DSLs hold for UIs ■ Looking at JavaFX Script examples ■ Comparing JavaFX to its main rivals “If the only tool you have is a hammer, you tend to see every problem as a nail,” American psychologist Abraham Maslow once observed. Language advocacy is a popular pastime with many programmers, but what many fail to realize is that programming languages are like tools: each is good at some things and next to useless at others. Java, inspired as it was by prior art like C and Smalltalk, sports a solid general-purpose syntax that gets the job done with the minimum of fuss in the majority of cases. Unfortunately, there will always be those areas that, by their very nature, demand something a little more specialized.
[Show full text]
Graph Database Management Systems Oshini Goonetilleke
Graph Database Management Systems Storage, Management and Query Processing A thesis submitted in fulfilment of the requirements for the degree of Doctor of Philosophy Oshini Goonetilleke School of Science College of Science, Engineering, and Health RMIT University December, 2017 Declaration I certify that except where due acknowledgement has been made, the work is that of the author alone; the work has not been submitted previously, in whole or in part, to qualify for any other academic award; the content of the thesis is the result of work which has been carried out since the official commencement date of the approved research program; and, any editorial work, paid or unpaid, carried out by a third party is acknowledged; and, ethics procedures and guidelines have been followed. Oshini Goonetilleke School of Science RMIT University 20th December, 2017 Acknowledgements First, I would like to thank my supervisor, Timos Sellis, for all his advice, support and patience throughout my PhD journey. Over the past four years while working with Timos, I have learned many things about research and many important lessons in life. I feel privileged to have worked under his guidance. I would also like to thank my other supervisor, Jenny Zhang, for her advice and support during my PhD. I had an amazing group of collaborators, each contributing and supporting me in different ways. I would like to thank each of them: Saket Sathe, Danai Koutra, David Meibusch, Ben Barham and Kewen Liao. Saket for his feedback and advice during the early years of my PhD and his humorous insights; and Danai for long conversations about research problems at odd hours in the US, and suggesting interesting directions for my work.
[Show full text]
Dynamic Tracing with Dtrace & Systemtap
Dynamic Tracing with DTrace SystemTap Sergey Klyaus Copyright © 2011-2016 Sergey Klyaus This work is licensed under the Creative Commons Attribution-Noncommercial-ShareAlike 3.0 License. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc-sa/3.0/ or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA. Table of contents Introduction 7 Foreword . 7 Typographic conventions . 9 TSLoad workload generator . 12 Operating system Kernel . 14 Module 1: Dynamic tracing tools. dtrace and stap tools 15 Tracing . 15 Dynamic tracing . 16 DTrace . 17 SystemTap . 19 Safety and errors . 22 Stability . 23 Module 2: Dynamic tracing languages 25 Introduction . 25 Probes . 27 Arguments . 33 Context . 34 Predicates . 35 Types and Variables . 37 Pointers . 40 Strings and Structures . 43 Exercise 1 . 44 Associative arrays and aggregations . 44 Time . 48 Printing and speculations . 48 Tapsets translators . 50 Exercise 2 . 52 Module 3: Principles of dynamic tracing 54 Applying tracing . 54 Dynamic code analysis . 55 Profiling . 61 Performance analysis . 65 Pre- and post-processing . 66 Vizualization . 70 Module 4: Operating system kernel tracing 74 Process management . 74 3 Exercise 3 . 86 Process scheduler . 87 Virtual Memory . 105 Exercise 4 . 116 Virtual File System . 116 Block Input-Output . 122 Asynchronicity in kernel . 131 Exercise 5 . 132 Network Stack . 134 Synchronization primitives . 138 Interrupt handling and deferred execution . 143 Module 5: Application tracing 146 Userspace process tracing . 146 Unix C library . 149 Exercise 6 . 152 Java Virtual Machine . 153 Non-native languages . 160 Web applications . 165 Exercise 7 . 172 Appendix A. Exercise hints and solutions 173 Exercise 1 .
[Show full text]
Sun Cloud Computing Strategy NDA-021909 V5.Odp
SUBTITLE WITH TWO LINES OF TEXT VONIF NECESSARY GRIDS ZU CLOUDS Constantin Gonzalez Principal Field Technologist Sun Microsystems GmbH 1 • Neuigkeiten • Teil 1: Die Pflicht > Neue Grid-Bausteine • Teil 2: Die Kür > Cloud Computing mit Sun Agenda • Nächste Schritte für Sie 2 kauft http://www.oracle.com/sun 3 Neue Bausteine für das Grid 4 Die Sun x86 Serverfamilie Sun Blade 6000 Sun Blade Sun Blade Sun Blade Sun Blade Sun Blade X6240 X6440 X6270 X6275 X6450 Blades NEU NEU 8 Sockel Daten- Sun Fire X4600 M2 Sun Fire X4540 Server Sun Fire X4450 2 Sockel Sun Fire X4170 Sun Fire X4270 4 Sockel ^^ NEU NEU Sun Fire X4275 NEU 2 Sockel Sun Fire X4140 Sun Fire X4240 Sun Fire X4440 4 Sockel 2 Sockel NEU Sun Fire X2200 M2 Sun Fire X2270 5 Sun Ultra 27 Workstation ● Prozessor ● 1x Intel Xeon 3500 (Quad-Core 130W) ● Memory ● 6x UDDR3-1333 DIMMs (12 GB Max) (24 GB Max Post-RR) ● I/O ● 2x PCIe Gen 2 x16 slot (x16 el/mec) ● 1x PCIe Gen 2 x8 slot (x4 electrical) ● 1x PCIe Gen 1 x8 slot (x4 electrical) ● 1x PCIe Gen 1 x1 slot (x1 el/mec) ● 1x PCI (32-bit/33MHz) ● 8x USB 2.0, 2x IEEE 1394a (FireWire) ● 1x Gigabit Ethernet ● Storage ● 4x 3.5” Drive bays ● SATA or SAS HDDs ● DVD ● Betriebssystem ● Solaris, Linux, Windows (auch 2008 Server) 6 Sun Fire X2270 ● Prozessor ● 2 Intel Xeon 5500 Prozessoren ● 12x DDR3 Memory Slots ● I/O ● 1x PCI-E 2.0 slot (x16 lanes) ● 2x Gigabit Ethernet ports ● 4x LFF HDD or SSD (3.5”) ● Non-volatile boot media (USB) ● 2x Flash DIMMs ● Verfügbarkeit ● 1x 600W High Efficiency PSU ● 3x Fan Blowers ● Management ● Sun ILOM Service Processor
[Show full text]
Applying the Engineering Statechart Formalism to the Evaluation of Soft Real-Time in Operating Systems - a Use Case Tailored Modeling and Analysis Technique
Dissertation zur Erlangung des Grades des Doktors der Ingenieurwissenschaften der Naturwissenschaftlich-Technischen Fakultäten der Universitätdes Saarlandes R S V E I T I A N S U S S A I R S A V I E N Applying the Engineering Statechart Formalism to the Evaluation of Soft Real-Time in Operating Systems - A Use Case Tailored Modeling and Analysis Technique Vorgelegt von Alexander Koenen-Dresp Glons, Belgien Tag der Einreichung: 4. Juli 2008 Tag des Kolloquiums: 28. Oktober 2008 Dekan: Prof. Dr. Joachim Weickert Vorsitzender der Prüfungskommission: Prof. Dr. Reinhard Wilhelm 1. Berichterstatter: Prof. Dr. Helge Scheidig 2. Berichterstatter: Prof. Bernd Finkbeiner, PhD Akademischer Mitarbeiter: Dr. Mark Hillebrand Acknowledgements First of all I thank my primary advisor Professor Helge Scheidig for the unique opportu- nity to participate in his research. I am also very grateful for the excellent supervision and the guidance Professor Bernd Finkbeiner gave me during my research. Without his clear guidelines on the methodology, this thesis would never have been possible. My colleges Sebastian Schöningand Reinhart Spurk also greatly contributed to this work - thank you. Words cannot express my gratitude towards my wife Wiebke. Her never-ending fight for my success was the best support for which I could ever have hoped. I am very grateful to my three proof readers, Calogero Cumbo, Christian Franze and Robert Koch. To Robert I owe thanks for his friendship and personal support over the last decade. Since my research and the writing of this thesis was conducted while I was a full-time employee of the German Armed Forces Command Control and Information System Reg- iment (GAFCCIS Rgt) in Cologne and later of the NATO Programming Centre (NPC) in Glons (Belgium), I would like to thank all my superior officers for their support.
[Show full text]
Deploying Javafx Applications Release 2.2.40 E20472-11
JavaFX Deploying JavaFX Applications Release 2.2.40 E20472-11 September 2013 JavaFX Deploying JavaFX Applications Release 2.2.40 E20472-11 Copyright © 2008, 2013 Oracle and/or its affiliates. All rights reserved. Primary Author: Dmitry Kostovarov Contributor: This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.
[Show full text]
Sun Datacenter Switch 3456 System Architecture Sun Microsystems, Inc
SUN™ DATACENTER SWITCH 3456 SYSTEM ARCHITECTURE Massively Scalable InﬁniBand Switch Architecture for Petascale Computing White Paper November 2007 Sun Microsystems, Inc. Table of Contents Executive Summary . 1 Deploying Massive InfiniBand Connectivity . 2 The Drive for Performance and Scale . 2 The Sun™ Datacenter Switch 3456 System . 4 The Sun Constellation System . 7 Sun Datacenter Switch 3456 Architecture . 9 Constraints for Large InfiniBand Switches . 9 Chassis Overview . 11 Component Architecture . 17 Integrated Switch Control and Management . 21 InfiniBand Management System . 21 Management Components . 24 Chassis Management Controller Architecture . 25 Deploying the Sun Datacenter Switch 3456 . 27 Sun Blade™ 6048 Modular System Overview . 27 Scaling to Multiple Core Switches . 30 A Massive Supercomputing Cluster at the Texas Advanced Computing Center . 31 Software for Standards-Based Supercomputers . 33 Sun Grid Engine . 33 Sun xVM Ops Center . 35 Sun Visualization System . 37 Conclusion . 39 Fore More Information . 39 Executive Summary Sun Microsystems, Inc. Executive Summary Clusters or grids constructed from open and standard commercial off the shelf (COTS) systems now dominate the Top500 index of supercomputer sites1, providing an attractive way to rapidly (and affordably) construct supercomputer-class systems of interconnected nodes. The largest of these supercomputers are now driving toward petascale deployments, delivering petaﬂops of computational capacity and petabytes of storage capacity. In spite of ongoing successes,
[Show full text]
LEXIS Deliverable D4.1
Large-scale EXecution for Industry & Society Deliverable D4.1 Analysis of mechanisms for securing federated infrastructure Co-funded by the Horizon 2020 Framework Programme of the European Union Grant Agreement Number 825532 ICT-11-2018-2019 (IA - Innovation Action) DELIVERABLE ID | TITLE D4.1 | Analysis of mechanisms for securing federated infrastructure RESPONSIBLE AUTHOR Frédéric Donnat (O24) WORKPACKAGE ID | TITLE WP4 | Orchestration and Secure Cloud/HPC Services Provisioning WORKPACKAGE LEADER LINKS DATE OF DELIVERY (CONTRACTUAL) 30/09/2019 (M09) DATE OF DELIVERY (SUBMITTED) 17/10/2019 (M10) VERSION | STATUS V1.3.2 | Final TYPE OF DELIVERABLE R (Report) DISSEMINATION LEVEL PU(Public) AUTHORS (PARTNER) O24; LINKS; IT4I; LRZ INTERNAL REVIEW Martin Golasowski (IT4I); Roberto Peveri (TESEO) Project Coordinator: Dr. Jan Martinovič – IT4Innovations, VSB – Technical University of Ostrava E-mail: [email protected], Phone: +420 597 329 598, Web: https://lexis-project.eu LEXIS: Large-scale EXecution for Industry & Society DOCUMENT VERSION VERSION MODIFICATION(S) DATE AUTHOR(S) 0.1 Defined the Table of Content; first 31/07/2019 Donnat F. (O24), Scionti A. (LINKS) draft of the document 0.2 Improving text also in connection 18/09/2019 Colucci A. (O24), Donnat F. (O24), Scionti A. with D2.2 (LINKS) 0.3 Final draft completed, ready for 19/09/2019 Colucci A. (O24), Donnat F. (O24), Scionti A. internal review (LINKS) 0.4 Last check and cleaning of the text 20/09/2019 Scionti A. (LINKS) before internal reviews 0.5 Internal review 26/09/2019 Golasowski M. (IT4I), Roberto Peveri (TESEO) 0.6 Answering comments 28/09/2019 Scionti A.
[Show full text]
Cloud Deployment Model Cookbook for Amazon EKS / Forgerock Identity Platform 6.5
Cloud Deployment Model Cookbook for Amazon EKS / ForgeRock Identity Platform 6.5 Latest update: 6.5.2 Gina Cariaga David Goldsmith Shankar Raman ForgeRock AS. 201 Mission St., Suite 2900 San Francisco, CA 94105, USA +1 415-599-1100 (US) www.forgerock.com Copyright © 2018 ForgeRock AS. Abstract Step-by-step instructions for getting the CDM up and running on Amazon Elastic Cloud Services for Kubernetes (Amazon EKS). This work is licensed under the Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc-nd/3.0/ or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA. ForgeRock® and ForgeRock Identity Platform™ are trademarks of ForgeRock Inc. or its subsidiaries in the U.S. and in other countries. Trademarks are the property of their respective owners. UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
[Show full text]
Steinmacher, 2015
Supporting newcomers to overcome the barriers to contribute to open source software projects Igor Fabio Steinmacher TEXT SUBMITTED TO THE INSTITUTE OF MATHEMATICS AND STATISTICS OF THE UNIVERSITY OF SÃO PAULO FOR THE DOCTORAL DEGREE IN SCIENCE Program: Computer Science Advisor: Professor Marco Aurélio Gerosa This research is supported by Fundação Araucária (projeto DINTER UTFPR/IME- USP), CAPES (proc. BEX 2037-13-7), NAWEB, NAPSoL-PRP-USP, FAPESP and CNPq (Universal 477831/2013-3) São Paulo, November, 2015 Supporting newcomers to overcome the barriers to contribute to open source software projects This version of the thesis contains the changes suggested by the Committee Members during the public defense of the original version of this work, which occurred in Feb 26th, 2015. A copy of the original version is available at Institute of Mathematics and Statistics (IME) -University of São Paulo (USP) Committee Members: Prof. Dr. Marco Aurélio Gerosa (advisor) - IME-USP Prof. Dr. Christoph Treude - UFRN Prof. Dr. Tayana Uchoa Conte – UFAM Prof. Dr. José Carlos Maldonado – ICMC-USP Prof. Dr. Daniel Batista Macêdo – IME-USP Acknowledgements First, I would like to thank my advisor Marco Aurélio Gerosa for the guidance and helpful discussions during all these years, putting me on track whenever I got lost. His way of thinking and supporting me on my research taught me everything I know about being a researcher and conducting research. Marco helped me, guided me, and became a good friend. I also would like to thank David F. Redmiles, who received and welcomed me at UCI. I had a really good time there and could learn a lot with his suggestions and feedbacks.
[Show full text]
Developing SDK Documentation with Javadoc Matthew Stern Sr
Developing SDK Documentation with Javadoc Matthew Stern Sr. Technical Writer Kofax Image Products Overview • What SDK users expect • How documentation generators like Javadoc can help • How Javadoc works • Strategies for working with developers • How to integrate Javadoc to produce complete SDK documentation What SDK users expect • Current and complete API reference • Useful real-world code samples • Theory of operation • Dependencies Developing SDK Documentation with Javadoc 1 Challenges with SDK documentation • How to create a current and complete API reference when the code can change frequently • How to provide the API reference with other needed pieces of information How documentation generators help • Create an API reference from the source code • Produce documents in a number of formats • Generate an API reference each time the code is built • Enable developers to create a reference for their own code Documentation generators • Javadoc • CppDoc • NDoc • Doxygen • Innovasys Document! X • Key: Each documentation generator fits a specific programming language and target reader Developing SDK Documentation with Javadoc 2 Demo: Generating Javadoc • Examining source code comments • Modifying comments • Generating the Javadoc Who should write Javadoc? “Here at Java Software, the doc comments are not owned exclusively by writers or programmers, but their ownership is shared between them. It is a basic premise that writers and programmers honor each other’s capabilities and both contribute to the best doc comments possible.” Strategies
[Show full text]